Account Invitations

Fetching a list of Account Invitations

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.

get/account_invitations

Request

  • Base URL
    https://api.mavenlink.com/api/v1
  • Auth
    none declared

Query parameters

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.

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.

pageinteger
per_pageinteger
searchstring

Response

A list of Account Invitations have been retrieved.

countinteger
account_invitationsobject
usersobject
rolesobject

Changes

No recorded changes to this operation across all 1 revision of this API.