All endpoints other than the api docs and health are protected and require you to use your authentication token. Voxmind uses long-lived tokens for the service to service integration to ease the use of our APIs and keep integration times short.
During your sign-up with Voxmind, we will share a trial token with you which you can use with our APIs. The token is only valid for your organisation. The token will expire within 15days-3months depending on your trial period so make sure that you issue a long lived token berore you start using our services in production.
By default long lived tokens don't expire. However, we suggest that you have a plan to replace the tokens periodically to keep your data safe. Expiration time can be configured during the token creation time. Simply issue a new token anytime, as long as your current token is active. After you replace a token make sure to delete/deactivate the tokens not in use.
Enroll a user
| Accept required | string Value: "application/json" |
| voice_data required | string <binary> The binary blob of your user's voice (live recording) |
| request_uuid required | string The request uuid we will return back to you when the enrollment status is ready |
| external_id required | string Your user's identifier of your system in a string format |
| device_fingerprint | string (Optional) The unique device's fingerprint that the user is using during enrollment |
| device_type | integer (Optional) The device's type that the user is using during enrollment |
| language | string^[a-z]{2}-[A-Z]{2}$ Default: "en-UK" (Optional) The language of the text in [ISO 639]-[alpha 2 code of country codes] |
{- "voice_data": "string",
- "request_uuid": "2529fe6f-6039-4cdb-be68-f5982ede183c",
- "external_id": "12312532444",
- "device_fingerprint": "string",
- "device_type": 0,
- "language": "en-UK"
}{- "message": "Your request has been accepted and is being processed"
}Verify a user
| Accept required | string Value: "application/json" |
| voice_data required | string <binary> The binary blob of your user's voice (live recording) |
| request_uuid required | string The request uuid we will return back to you when the enrollment status is ready |
| external_id | string Your user's identifier of your system in a string format |
| device_fingerprint | string (Optional) The unique device's fingerprint that the user is using during enrollment |
| device_type | integer (Optional) The device's type that the user is using during enrollment |
| language | string^[a-z]{2}-[A-Z]{2}$ Default: "en-UK" (Optional) The language of the text in [ISO 639]-[alpha 2 code of country codes] |
{- "voice_data": "string",
- "request_uuid": "2529fe6f-6039-4cdb-be68-f5982ede183c",
- "external_id": "12312532444",
- "device_fingerprint": "string",
- "device_type": 0,
- "language": "en-UK"
}{- "message": "Your request has been accepted and is being processed"
}| filter | string Example: filter=email=xx@voxmind.ai,phone_number!=null,id=gte:2223 Comma separated filters. Equal and not equal by using = and !=. Advanced comparator methods available with colon delimiter. Comparators "gt" | "gte" | "lt" | "lte" | "like" | "ilike" |
| sort | string Example: sort=created_at:asc,name:desc Comma separated sort orders. Use colon delimiter to set ascending or descending ordering. |
| per_page | integer <= 300 Default: 100 Controls the total number of returned entities per page. Similar to limit. |
| page | integer >= 1 Example: page=20 Iterator for the pages of records we have based on the items listed per_page. Please also see |
| Accept required | string Value: "application/json" |
{- "id": 1,
- "subject": "string",
- "audience": "PUBLIC_API",
- "algorithm": "string",
- "friendly_name": "voxmind-serviceX-prod",
- "expires_at": "2015-01-28T09:52:53Z",
- "not_before": "2015-01-28T09:52:53Z",
- "enabled": true,
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}Issue a new long lived token
| Accept required | string Value: "application/json" |
| friendly_name | string A friendly name you can use to identify this token later on in case you want to delete it or enable/disable it. |
| expires_at | string <date-time> When the token expires in UTC |
| not_before | string <date-time> When the token can be used for the first time |
| enabled | boolean Default: true If the token is enabled or not |
{- "friendly_name": "voxmind-serviceX-prod",
- "expires_at": "2015-01-28T09:52:53Z",
- "not_before": "2015-01-28T09:52:53Z",
- "enabled": true
}{- "bearer": "eyJjbGllbnRfaWQiOiJZekV6TUdkb01ISm5PSEJpT0cxaWJEaHlOVEE9IiwicmVzcG9uc2Vf\ndHlwZSI6ImNvZGUiLCJzY29wZSI6ImlusdHJvc2NwZWN0X3Rva2VucywgcmV2b2tlX3Rva2Vu\ncyIsImlzcyI6ImJqaElSak0xY1hwYWEyMXpkV3RJU25wNmVqbE1iazQ0YlRsTlpqazNkWEU9\nIiwic3ViIjoiWXpFek1HZG9NSEpuT0hCaU9HMWliRGh5TlRBPSIsImF1ZCI6Imh0dHBzOi8v\nbG9jYWxob3N0Ojg0NDMve3RpZH0ve2FpZH0vb2F1dGgyL2F1dGhvcml6ZSIsImp0aSI6IjE1\nMTYyMzkwMjIiLCJleHAiOiIyMDIxLTA1LTE3VDA3OjA5OjQ4LjAwMCswNTQ1In0\n",
- "token": {
- "id": 1,
- "subject": "string",
- "audience": "PUBLIC_API",
- "algorithm": "string",
- "friendly_name": "voxmind-serviceX-prod",
- "expires_at": "2015-01-28T09:52:53Z",
- "not_before": "2015-01-28T09:52:53Z",
- "enabled": true,
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}
}Get token details
| resourceId required | string <integer> |
| Accept required | string Value: "application/json" |
{- "id": 1,
- "subject": "string",
- "audience": "PUBLIC_API",
- "algorithm": "string",
- "friendly_name": "voxmind-serviceX-prod",
- "expires_at": "2015-01-28T09:52:53Z",
- "not_before": "2015-01-28T09:52:53Z",
- "enabled": true,
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}Update a token
| resourceId required | string <integer> |
| Accept required | string Value: "application/json" |
| enabled | boolean If the token is enabled or not |
{- "enabled": true
}{- "id": 1,
- "subject": "string",
- "audience": "PUBLIC_API",
- "algorithm": "string",
- "friendly_name": "voxmind-serviceX-prod",
- "expires_at": "2015-01-28T09:52:53Z",
- "not_before": "2015-01-28T09:52:53Z",
- "enabled": true,
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}Delete a token record
| resourceId required | string <integer> |
| Accept required | string Value: "application/json" |
{- "id": 1,
- "subject": "string",
- "audience": "PUBLIC_API",
- "algorithm": "string",
- "friendly_name": "voxmind-serviceX-prod",
- "expires_at": "2015-01-28T09:52:53Z",
- "not_before": "2015-01-28T09:52:53Z",
- "enabled": true,
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}Get an organisation
| resourceId required | string <integer> |
| Accept required | string Value: "application/json" |
{- "id": 1,
- "name": "Test Ltd.",
- "address": "7 Bell Yard, London, England WC2A 2SJ, GB",
- "email": "test@voxmind.ai",
- "phone_number": "+47 xxxxxxxxx",
- "vat": "1234575545",
- "vies": "1234575545",
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}Update organisation details
| resourceId required | string <integer> |
| Accept required | string Value: "application/json" |
| name | string The name of the organisation |
| address | string Specifies the address of the organisation |
string Main organisation's email | |
| phone_number | string Main organisation's phone number |
| vat | string Organisation's VAT number |
| vies | string Organisation's VIES number |
{- "name": "Test Ltd.",
- "address": "7 Bell Yard, London, England WC2A 2SJ, GB",
- "email": "test@voxmind.ai",
- "phone_number": "+47 xxxxxxxxx",
- "vat": "1234575545",
- "vies": "1234575545"
}{- "id": 1,
- "name": "Test Ltd.",
- "address": "7 Bell Yard, London, England WC2A 2SJ, GB",
- "email": "test@voxmind.ai",
- "phone_number": "+47 xxxxxxxxx",
- "vat": "1234575545",
- "vies": "1234575545",
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}| filter | string Example: filter=email=xx@voxmind.ai,phone_number!=null,id=gte:2223 Comma separated filters. Equal and not equal by using = and !=. Advanced comparator methods available with colon delimiter. Comparators "gt" | "gte" | "lt" | "lte" | "like" | "ilike" |
| sort | string Example: sort=created_at:asc,name:desc Comma separated sort orders. Use colon delimiter to set ascending or descending ordering. |
| per_page | integer <= 300 Default: 100 Controls the total number of returned entities per page. Similar to limit. |
| page | integer >= 1 Example: page=20 Iterator for the pages of records we have based on the items listed per_page. Please also see |
| Accept required | string Value: "application/json" |
{- "results": [
- {
- "id": 1,
- "org_id": 123124,
- "external_id": "test@voxmind.ai",
- "is_active": true,
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}
]
}Get a user
| resourceId required | string <integer> |
| Accept required | string Value: "application/json" |
{- "id": 1,
- "org_id": 123124,
- "external_id": "test@voxmind.ai",
- "is_active": true,
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}Update a user
| resourceId required | string <integer> |
| Accept required | string Value: "application/json" |
| is_active | boolean Default: true User's active status |
{- "is_active": true
}{- "id": 1,
- "org_id": 123124,
- "external_id": "test@voxmind.ai",
- "is_active": true,
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}Delete a user
| resourceId required | string <integer> |
| Accept required | string Value: "application/json" |
{- "id": 1,
- "org_id": 123124,
- "external_id": "test@voxmind.ai",
- "is_active": true,
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}Enroll a user
| Accept required | string Value: "application/json" |
| voice_data required | string <binary> The binary blob of your user's voice (live recording) |
| request_uuid required | string The request uuid we will return back to you when the enrollment status is ready |
| external_id required | string Your user's identifier of your system in a string format |
| device_fingerprint | string (Optional) The unique device's fingerprint that the user is using during enrollment |
| device_type | integer (Optional) The device's type that the user is using during enrollment |
| language | string^[a-z]{2}-[A-Z]{2}$ Default: "en-UK" (Optional) The language of the text in [ISO 639]-[alpha 2 code of country codes] |
{- "voice_data": "string",
- "request_uuid": "2529fe6f-6039-4cdb-be68-f5982ede183c",
- "external_id": "12312532444",
- "device_fingerprint": "string",
- "device_type": 0,
- "language": "en-UK"
}{- "message": "Your request has been accepted and is being processed"
}Verify a user
| Accept required | string Value: "application/json" |
| voice_data required | string <binary> The binary blob of your user's voice (live recording) |
| request_uuid required | string The request uuid we will return back to you when the enrollment status is ready |
| external_id | string Your user's identifier of your system in a string format |
| device_fingerprint | string (Optional) The unique device's fingerprint that the user is using during enrollment |
| device_type | integer (Optional) The device's type that the user is using during enrollment |
| language | string^[a-z]{2}-[A-Z]{2}$ Default: "en-UK" (Optional) The language of the text in [ISO 639]-[alpha 2 code of country codes] |
{- "voice_data": "string",
- "request_uuid": "2529fe6f-6039-4cdb-be68-f5982ede183c",
- "external_id": "12312532444",
- "device_fingerprint": "string",
- "device_type": 0,
- "language": "en-UK"
}{- "message": "Your request has been accepted and is being processed"
}| filter | string Example: filter=email=xx@voxmind.ai,phone_number!=null,id=gte:2223 Comma separated filters. Equal and not equal by using = and !=. Advanced comparator methods available with colon delimiter. Comparators "gt" | "gte" | "lt" | "lte" | "like" | "ilike" |
| sort | string Example: sort=created_at:asc,name:desc Comma separated sort orders. Use colon delimiter to set ascending or descending ordering. |
| per_page | integer <= 300 Default: 100 Controls the total number of returned entities per page. Similar to limit. |
| page | integer >= 1 Example: page=20 Iterator for the pages of records we have based on the items listed per_page. Please also see |
| Accept required | string Value: "application/json" |
{- "id": 1,
- "subject": "string",
- "audience": "PUBLIC_API",
- "algorithm": "string",
- "friendly_name": "voxmind-serviceX-prod",
- "expires_at": "2015-01-28T09:52:53Z",
- "not_before": "2015-01-28T09:52:53Z",
- "enabled": true,
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}Issue a new long lived token
| Accept required | string Value: "application/json" |
| friendly_name | string A friendly name you can use to identify this token later on in case you want to delete it or enable/disable it. |
| expires_at | string <date-time> When the token expires in UTC |
| not_before | string <date-time> When the token can be used for the first time |
| enabled | boolean Default: true If the token is enabled or not |
{- "friendly_name": "voxmind-serviceX-prod",
- "expires_at": "2015-01-28T09:52:53Z",
- "not_before": "2015-01-28T09:52:53Z",
- "enabled": true
}{- "bearer": "eyJjbGllbnRfaWQiOiJZekV6TUdkb01ISm5PSEJpT0cxaWJEaHlOVEE9IiwicmVzcG9uc2Vf\ndHlwZSI6ImNvZGUiLCJzY29wZSI6ImlusdHJvc2NwZWN0X3Rva2VucywgcmV2b2tlX3Rva2Vu\ncyIsImlzcyI6ImJqaElSak0xY1hwYWEyMXpkV3RJU25wNmVqbE1iazQ0YlRsTlpqazNkWEU9\nIiwic3ViIjoiWXpFek1HZG9NSEpuT0hCaU9HMWliRGh5TlRBPSIsImF1ZCI6Imh0dHBzOi8v\nbG9jYWxob3N0Ojg0NDMve3RpZH0ve2FpZH0vb2F1dGgyL2F1dGhvcml6ZSIsImp0aSI6IjE1\nMTYyMzkwMjIiLCJleHAiOiIyMDIxLTA1LTE3VDA3OjA5OjQ4LjAwMCswNTQ1In0\n",
- "token": {
- "id": 1,
- "subject": "string",
- "audience": "PUBLIC_API",
- "algorithm": "string",
- "friendly_name": "voxmind-serviceX-prod",
- "expires_at": "2015-01-28T09:52:53Z",
- "not_before": "2015-01-28T09:52:53Z",
- "enabled": true,
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}
}Get token details
| resourceId required | string <integer> |
| Accept required | string Value: "application/json" |
{- "id": 1,
- "subject": "string",
- "audience": "PUBLIC_API",
- "algorithm": "string",
- "friendly_name": "voxmind-serviceX-prod",
- "expires_at": "2015-01-28T09:52:53Z",
- "not_before": "2015-01-28T09:52:53Z",
- "enabled": true,
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}Update a token
| resourceId required | string <integer> |
| Accept required | string Value: "application/json" |
| enabled | boolean If the token is enabled or not |
{- "enabled": true
}{- "id": 1,
- "subject": "string",
- "audience": "PUBLIC_API",
- "algorithm": "string",
- "friendly_name": "voxmind-serviceX-prod",
- "expires_at": "2015-01-28T09:52:53Z",
- "not_before": "2015-01-28T09:52:53Z",
- "enabled": true,
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}Delete a token record
| resourceId required | string <integer> |
| Accept required | string Value: "application/json" |
{- "id": 1,
- "subject": "string",
- "audience": "PUBLIC_API",
- "algorithm": "string",
- "friendly_name": "voxmind-serviceX-prod",
- "expires_at": "2015-01-28T09:52:53Z",
- "not_before": "2015-01-28T09:52:53Z",
- "enabled": true,
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}| resourceId required | string <integer> |
| Accept required | string Value: "application/json" |
{- "id": 1,
- "org_id": 23,
- "settings": {
- "alert_on_failure": true
}, - "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}Update an organisation's settings
| resourceId required | string <integer> |
| Accept required | string Value: "application/json" |
| org_id | integer The associated's organisation id |
object JSONB settings for the organisation. Dictated by voxmind's API |
{- "org_id": 23,
- "settings": {
- "alert_on_failure": true
}
}{- "id": 1,
- "org_id": 23,
- "settings": {
- "alert_on_failure": true
}, - "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}| resourceId required | string <integer> |
| filter | string Example: filter=email=xx@voxmind.ai,phone_number!=null,id=gte:2223 Comma separated filters. Equal and not equal by using = and !=. Advanced comparator methods available with colon delimiter. Comparators "gt" | "gte" | "lt" | "lte" | "like" | "ilike" |
| sort | string Example: sort=created_at:asc,name:desc Comma separated sort orders. Use colon delimiter to set ascending or descending ordering. |
| per_page | integer <= 300 Default: 100 Controls the total number of returned entities per page. Similar to limit. |
| page | integer >= 1 Example: page=20 Iterator for the pages of records we have based on the items listed per_page. Please also see |
| Accept required | string Value: "application/json" |
{- "results": [
- {
- "id": 1,
- "org_id": 123124,
- "language": "en-US",
- "text_code": 2,
- "text": "The registration text is meant to be read during the enrollment of the user etc",
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}
]
}Create a new predefined text
| Accept required | string Value: "application/json" |
| org_id | integer The id of the organization the text belongs to |
| language | string The language of the text in iso 639+alpha 2 code of country codes |
| text_code | integer Text code to easily identify what the text is about! |
| text | string The actual text of overwritten by the customer |
{- "org_id": 123124,
- "language": "en-US",
- "text_code": 2,
- "text": "The registration text is meant to be read during the enrollment of the user etc"
}{- "id": 1,
- "org_id": 123124,
- "language": "en-US",
- "text_code": 2,
- "text": "The registration text is meant to be read during the enrollment of the user etc",
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}Get a predefined text
| resourceId required | string <integer> |
| Accept required | string Value: "application/json" |
{- "id": 1,
- "org_id": 123124,
- "language": "en-US",
- "text_code": 2,
- "text": "The registration text is meant to be read during the enrollment of the user etc",
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}Update a predefined text
| resourceId required | string <integer> |
| Accept required | string Value: "application/json" |
| org_id | integer The id of the organization the text belongs to |
| language | string The language of the text in iso 639+alpha 2 code of country codes |
| text_code | integer Text code to easily identify what the text is about! |
| text | string The actual text of overwritten by the customer |
{- "org_id": 123124,
- "language": "en-US",
- "text_code": 2,
- "text": "The registration text is meant to be read during the enrollment of the user etc"
}{- "id": 1,
- "org_id": 123124,
- "language": "en-US",
- "text_code": 2,
- "text": "The registration text is meant to be read during the enrollment of the user etc",
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}Delete a predefined text
| resourceId required | string <integer> |
| Accept required | string Value: "application/json" |
{- "id": 1,
- "org_id": 123124,
- "language": "en-US",
- "text_code": 2,
- "text": "The registration text is meant to be read during the enrollment of the user etc",
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}| filter | string Example: filter=email=xx@voxmind.ai,phone_number!=null,id=gte:2223 Comma separated filters. Equal and not equal by using = and !=. Advanced comparator methods available with colon delimiter. Comparators "gt" | "gte" | "lt" | "lte" | "like" | "ilike" |
| sort | string Example: sort=created_at:asc,name:desc Comma separated sort orders. Use colon delimiter to set ascending or descending ordering. |
| per_page | integer <= 300 Default: 100 Controls the total number of returned entities per page. Similar to limit. |
| page | integer >= 1 Example: page=20 Iterator for the pages of records we have based on the items listed per_page. Please also see |
| Accept required | string Value: "application/json" |
{- "results": [
- {
- "id": 1,
- "details": {
- "weekly_verifications": 5000
}, - "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}
]
}Get a plan
| resourceId required | string <integer> |
| Accept required | string Value: "application/json" |
{- "id": 1,
- "details": {
- "weekly_verifications": 5000
}, - "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}| filter | string Example: filter=email=xx@voxmind.ai,phone_number!=null,id=gte:2223 Comma separated filters. Equal and not equal by using = and !=. Advanced comparator methods available with colon delimiter. Comparators "gt" | "gte" | "lt" | "lte" | "like" | "ilike" |
| sort | string Example: sort=created_at:asc,name:desc Comma separated sort orders. Use colon delimiter to set ascending or descending ordering. |
| per_page | integer <= 300 Default: 100 Controls the total number of returned entities per page. Similar to limit. |
| page | integer >= 1 Example: page=20 Iterator for the pages of records we have based on the items listed per_page. Please also see |
| Accept required | string Value: "application/json" |
{- "results": [
- {
- "id": 1,
- "org_id": 33,
- "sub_id": 12,
- "invoice_sequence": 1,
- "quotas": {
- "weekly_verifications": 222
}, - "file_ref": "4d61d50295d55da651aa534a049fc2f159414b89d8d29a56160a266539acfcfc",
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}
]
}Get an invoice
| resourceId required | string <integer> |
| Accept required | string Value: "application/json" |
{- "id": 1,
- "org_id": 33,
- "sub_id": 12,
- "invoice_sequence": 1,
- "quotas": {
- "weekly_verifications": 222
}, - "file_ref": "4d61d50295d55da651aa534a049fc2f159414b89d8d29a56160a266539acfcfc",
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}| filter | string Example: filter=email=xx@voxmind.ai,phone_number!=null,id=gte:2223 Comma separated filters. Equal and not equal by using = and !=. Advanced comparator methods available with colon delimiter. Comparators "gt" | "gte" | "lt" | "lte" | "like" | "ilike" |
| sort | string Example: sort=created_at:asc,name:desc Comma separated sort orders. Use colon delimiter to set ascending or descending ordering. |
| per_page | integer <= 300 Default: 100 Controls the total number of returned entities per page. Similar to limit. |
| page | integer >= 1 Example: page=20 Iterator for the pages of records we have based on the items listed per_page. Please also see |
| Accept required | string Value: "application/json" |
{- "results": [
- {
- "id": 1,
- "org_id": 123124,
- "plan_id": 1,
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}
]
}Get a subscription
| resourceId required | string <integer> |
| Accept required | string Value: "application/json" |
{- "id": 1,
- "org_id": 123124,
- "plan_id": 1,
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}| filter | string Example: filter=email=xx@voxmind.ai,phone_number!=null,id=gte:2223 Comma separated filters. Equal and not equal by using = and !=. Advanced comparator methods available with colon delimiter. Comparators "gt" | "gte" | "lt" | "lte" | "like" | "ilike" |
| sort | string Example: sort=created_at:asc,name:desc Comma separated sort orders. Use colon delimiter to set ascending or descending ordering. |
| per_page | integer <= 300 Default: 100 Controls the total number of returned entities per page. Similar to limit. |
| page | integer >= 1 Example: page=20 Iterator for the pages of records we have based on the items listed per_page. Please also see |
| Accept required | string Value: "application/json" |
{- "results": [
- {
- "id": 1,
- "user_id": 123124,
- "fingerprint": "hash123123kljsdaflkjsdfgljsdlkfdskjsldfj...",
- "type": 1,
- "last_used": "2015-01-28T09:52:53Z",
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}
]
}Get a device
| resourceId required | string <integer> |
| Accept required | string Value: "application/json" |
{- "id": 1,
- "user_id": 123124,
- "fingerprint": "hash123123kljsdaflkjsdfgljsdlkfdskjsldfj...",
- "type": 1,
- "last_used": "2015-01-28T09:52:53Z",
- "created_at": "2015-01-28T09:52:53Z",
- "updated_at": "2015-01-28T09:52:53Z"
}The queryable endpoints support filtering through flexible predicates.
filter query param. 400.Filters are comma separated, and use equal and not equal with = and !=.
Currently, the supported comparators are "gt" | "gte" | "lt" | "lte" | "like" | "ilike".
When using a comparator, colon : is used as a delimiter.
gt and gte Greater than, and greater than or equal to.lt and lte Less than, and less than or equal to.like and ilike
The like expression returns true if the string is contained in the set of strings represented by pattern. ilike can be used to make the match case insensitive.
If the pattern does not contain percent signs or underscore, then the pattern only represents the string itself, and in that case like acts like the equals operator._ in the pattern stands for (matches) any single character.% matches any string of zero or more characters.
Examples:// name = 'abc'
name=like:abc true
name=like:a% true
name=like:_b_ true
name=like:c false
name=like:_B_ false
name=ilike:_B_ true
// Filtering by name, will match all entities whose name starts with "somename"
filter=name=like:somename%
// Combining with version greater than or equal to 10
filter=name=like:somename%,version=gte:10
// Also filtering out all "Customer" businessTypes
filter=name=like:somename%,version=gte:10,businessType!=Customer
Sorting is similar to filter as far as the concept is concerned but the only options are only asc, desc. Again : is used as the delimeter.
Use comma (,) to sort by more than one field.
sort query param. 400.// Sorting by name asc and created_at desc
sort=name:asc,create_at:desc
// Sorting by updated_at asc
sort=updated_at:asc
Pagination is in its simple form for now, and is based on offset-limit approach to keep it simplified for the MVP. For user friendliness reasons we will convert offset, limit to page, per_page.
Later on we may explore cursor or other forms of pagination. We define two associated query params, these are page and per_page.
per_page, page query params.X-Total-Pages header which is present in all GET All responses.400.page_number-1 * per_page and limit is equal to per_page