Welcome to the NinjaCat Agency Management API.

The purpose of this API will allow developers to interact with their agency’s data – through a request & response interchange between applications. A sample use case would be if an agency needs to mass export a list of users to their agency, instead of going through the UI to invite user one by one, a mass update can be easily be done with this API.

Getting Started

To get started please make sure your agency has access to the API. If you are not sure if your agency has access or not, please navigate to the agency setting screen in NinjaCat and there should be an Apps tab there. If you don’t see the Apps tab, please contact your NinjaCat Account manager and request access for this API.

The Agency Identifier Key found in the Apps screen is needed for the x-api-key header. Here is an example of what the x-api-key header should look like. Every request that is found in this API requires this header.

x-api-key : {{agency_identifier_key}}

If the Client Id and Client Secret textbox are empty in the Apps tab, please click the generate button. The Client Id and Client Secret are needed to get a token in order to access the API. Please see the Get Token method in this documentation on how to get back the access token. The access token is needed in the authorization header, here is an example of what the authorization header should look like

Authorization : Bearer {{access_token}}

Replace {{access_token}} with the actual token you get.

Important Information

For this API null vs empty are two completely different things when making a create and update request. If you set a field to be null it will try to update that field with a null value. If you leave it empty it will not try to update that field on a certain resource during an update request and for a create request it will use default values for those empty fields.