Endpoints
Each endpoint provides access to read or potentially write data into the Firm App system.
For convenience and compatibility, each endpoint has it's own path such as /getUsers.
In order to provide full RPC encapsulation, clients can also use the /execute endpoint
and pass the endpoint id (in this example, 'getUsers') as part of the request body:
// Option One
await fetch('https://api.firm.app/getUser', {
body: JSON.stringify({
id: 'absdfjkfj',
}),
...
});
// Option Two
await fetch('https://api.firm.app/execute', {
body: JSON.stringify({
id: 'absdfjkfj',
endpointId: 'getUser',
}),
...
});
Issues | |
getIssue | The specified issue object. If the issue is not found then a `not_found` error will be returned. |
getIssues | Search issues by dates, status, assignee, requester, and more. |
Users | |
getRoles | Get all roles for your organization which can be assigned to a professional's roleIds field. |
getUser | The specified user object. If the user is not found then a `not_found` error will be returned. |
getUsers | Search for users by name, email, phone number, user type, verification status, and more. For large number of search results, make use of the page limits and cursors. |
saveUsers | This endpoint is transactional. If an error occurs, then no data was created or updated. Alternatively, use the [Data Import](https://my.firm.app/imports/docs) module for a more spreadsheet-friendly method of managing user profiles. |
Next up, learn about Error Codes »