API Reference

List all Apps

get
https://api.vcita.biz/v3/apps/apps

Returns apps available to the caller. Apps can be available because they are installed, offered by the directory, or assigned as internal.

Available for Staff, Directory, and Internal Tokens.

Query Params
assignment_type[]
array of strings

Filter by assignment type. Pass one or more values to return only apps whose assignment_types array includes at least one of the given values. Use bracket notation: ?assignment_type[]=installed&assignment_type[]=directory_offering. Heuristics: installed and internal cannot happen at the same time.

assignment_type[]
string

Filter by directory uid. Only available for Internal tokens. When omitted, returns apps across all directories. Ignored for Directory tokens, which always return apps scoped to their own directory.

boolean

Filter by app ownership. When set to true, returns only apps owned by the caller. For Internal tokens, this returns platform-wide apps that were created by the Internal token and do not belong to any directory. For Directory tokens, this returns apps that were created with the Directory token. Available for Internal and Directory tokens.

string

Filter by app code name (exact match).

string

Free-text search across name, app_code_name, and app market description fields (app_market.description.short_description, app_market.description.text).

Responses

400

Bad request. Invalid input data.

401

Unauthorized. The bearer token is missing or invalid.

403

Forbidden. You do not have access to this resource.

500

Internal server error.

Updated 16 days ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 16 days ago