Kantata Kantata OX Knowledge Base
Release Notes
Kantata OX Release Notes API Breaking Changes
Status Page
Kantata OX API Documentation

Account Invitations

Account Invitations represent invitations for non-users to join a Kantata OX account.

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.

Request
query Parameters
by_full_name
string

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

include
string

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.
only
string

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_pending
boolean
Default: true

Show only pending invitations.

order
string
Default: "created_at:desc"

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.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
search
string
Responses
200

A list of Account Invitations have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/account_invitations
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "account_invitations": {
    },
  • "users": {
    },
  • "roles": {
    }
}
Creating a new Account Invitation
Any members added in excess of your contracted license count are billed at a prorated subscription fee for
the remainder of the billing term. To review your contracted license count,
hover over Settings on the left-hand nav bar and select Plan on Kantata OX.


This endpoint has its own rate limit. See the Knowledge Base for more information.


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.


Request 
query Parameters
include
string
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.
    • 



 
Request Body schema: application/json
required
object
 
billability_target
integer <int32> 
 
bill_rate_in_cents
integer <int32> 
The default billing rate, in cents, for the user in a workspace on this account (when the workspace
does not use a rate card). This attribute can only be set if the current user is either an Administrator
or a Project Lead on the account.


 
cost_rate_in_cents
integer <int32> 
The default cost rate, in cents, for the user in a workspace on this account. This attribute can
only be set if the current user is an Administrator on the account.


 
default_read_only
boolean
The invited user should have read-only permissions.


 
default_role_id
integer <int32> 
The internal ID for the default role specified to the invited user.


 
email_address
required
string
The email address of the invited user. A link to accept the invitation is sent to this address.


 
full_name
required
string
The full name of the invited user.


 
headline
string
 
permission
string
The permission level of the invited user. See account_memberships for more details. Valid values
include administrator, reports_viewer_with_cost, reports_viewer, project_lead, project_creator, collaborator, and punch_clock.".


 
object
Typically populated programmatically by a third party system via an integration, this is an optional
object that holds data from an external system. It connects objects in an external system with objects in
Kantata OX (for example, to connect a Jira issue to a Kantata OX Project).


 
Responses 
200
Account Invitation has been created.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/account_invitations
Request samples 
application/json
{
  • "account_invitation": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "account_invitations": {
    },
  • "users": {
    },
  • "roles": {
    }
}
Fetching a single Account Invitation
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.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
query Parameters
include
string
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.
    • 



 
Responses 
200
The Account Invitation has been retrieved.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


get/account_invitations/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "account_invitations": {
    },
  • "users": {
    },
  • "roles": {
    }
}
Updating an existing Account Invitation
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.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
query Parameters
include
string
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.
    • 



 
Request Body schema: application/json
required
object
 
billability_target
boolean
 
bill_rate_in_cents
integer <int32> 
The default billing rate, in cents, for the user in a workspace on this account (when the workspace
does not use a rate card). This attribute can only be set if the current user is either an Administrator
or a Project Lead on the account.


 
cost_rate_in_cents
integer <int32> 
The default cost rate used, in cents, for the user in a workspace on this account. This attribute can
only be set if the current user is an Administrator on the account.


 
default_role_id
integer <int32> 
The internal ID for the default role specified to the invited user.


 
permission
string
The permission level of the invited user. See account_memberships for more details. Valid values
include administrator, reports_viewer_with_cost, reports_viewer, project_lead, project_creator, collaborator, and punch_clock.".


 
Responses 
200
Account Invitation has been updated.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


put/account_invitations/{id}
Request samples 
application/json
{
  • "account_invitation": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "account_invitations": {
    },
  • "users": {
    },
  • "roles": {
    }
}
Deleting an existing Account Invitation
The response will contain no content and an HTTP 204 status code if the request was
successful, or a standard Kantata OX error message explaining why the object could not be deleted.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
Responses 
204
Account Invitation has been deleted.


400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


delete/account_invitations/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
Resend an account invitation
Resends an account invitation email to an invited user.


This endpoint has its own rate limit. See the Knowledge Base for more information.


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.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
query Parameters
include
string
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.
    • 



 
Responses 
200
Account Invitation has been updated.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


put/account_invitations/{id}/resend
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "account_invitations": {
    },
  • "users": {
    },
  • "roles": {
    }
}
➔ Next to Account Memberships