Skip to content

Fetching a list of Account Invitations

Request

This endpoint returns structured Account Invitation objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the account_invitations top-level JSON key. Please see our Response Format section for more information.

Query
by_full_namestring

Show entries where the full name is like the specified parameter.

includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • default_role (Role) - The default role of the account.
  • invitee (User) - The new user who will receive the invitation.
  • inviter (User) - The user who has sent the invitation.
onlystring

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

only_pendingboolean

Show only pending invitations.

Default:true
orderstring

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: bill_rate:asc, bill_rate:desc, cost_rate:asc, cost_rate:desc, created_at:asc, created_at:desc, expiration_date:asc, expiration_date:desc, full_name:asc, full_name:desc, permission:asc, and permission:desc.

Default:"created_at:desc"
pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
searchstring
GET
/account_invitations
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/account_invitations?by_full_name=string&include=string&only=string&only_pending=true&order=created_at%3Adesc&page=1&per_page=20&search=string'

Responses

A list of Account Invitations have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
account_invitationsobject
usersobject
rolesobject
Response
{ "count": 0, "meta": { "count": 0, "page_count": 0, "page_number": 0, "page_size": 0 }, "results": [ { "key": "string", "id": "string" } ], "account_invitations": { "property1": { "bill_rate_in_cents": 0, "billability_target": 0, "cost_rate_in_cents": 0, "default_role_id": "string", "email_address": "string", "expiration_date": "string", "full_name": "string", "headline": "string", "invitee_id": "string", "inviter_id": "string", "pending": true, "permission": "string" }, "property2": { "bill_rate_in_cents": 0, "billability_target": 0, "cost_rate_in_cents": 0, "default_role_id": "string", "email_address": "string", "expiration_date": "string", "full_name": "string", "headline": "string", "invitee_id": "string", "inviter_id": "string", "pending": true, "permission": "string" } }, "users": { "property1": { "abbreviated_timezone": "string", "account_membership_id": "string", "bio": "string", "city": "string", "classification": "string", "country": "string", "custom_field_value_ids": [ "string" ], "email_address": "string", "external_reference_ids": [ "string" ], "full_name": "string", "headline": "string", "last_site_activity": "2019-08-24T14:15:22Z", "manager_id": "string", "photo_path": "string", "role_id": "string", "skill_ids": [ "string" ], "skill_membership_ids": [ "string" ], "state": "string", "website": "string", "work_sample_ids": [ "string" ] }, "property2": { "abbreviated_timezone": "string", "account_membership_id": "string", "bio": "string", "city": "string", "classification": "string", "country": "string", "custom_field_value_ids": [ "string" ], "email_address": "string", "external_reference_ids": [ "string" ], "full_name": "string", "headline": "string", "last_site_activity": "2019-08-24T14:15:22Z", "manager_id": "string", "photo_path": "string", "role_id": "string", "skill_ids": [ "string" ], "skill_membership_ids": [ "string" ], "state": "string", "website": "string", "work_sample_ids": [ "string" ] } }, "roles": { "property1": { "created_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "external_reference_ids": [ "string" ], "name": "string", "updated_at": "2019-08-24T14:15:22Z" }, "property2": { "created_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "external_reference_ids": [ "string" ], "name": "string", "updated_at": "2019-08-24T14:15:22Z" } } }