GET /apiv2/identities/getIdentities
Get all identities owned by an organisation, along with details on which company they are linked to. You must be an administrator of the organisation in question to be able to access this endpoint.Servers
- /
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
onlyUnlinkedIdentities |
Boolean | No |
Optional - whether or not to filter the results to identities that have not been linked to any companies in the system Default value: false |
identityProviderId |
Integer | No |
Optional - whether or not to filter by identities who are authenticated by a certain identity. If not provided, all identities will be returned provider |
organisationId |
Integer | No |
Optional. The ID in MachShip of the organisation. Only relevant if you are an administrator of more than one organisation in MachShip. If omitted, your current organisation will be returned |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.