Organization data
List identifiers for a record
Retrieve active identifiers assigned to one asset, location, or part
GET
/
identifiers
List identifiers for a record
curl --request GET \
--url https://api.oncanary.com/v1/identifiers \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.oncanary.com/v1/identifiers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.oncanary.com/v1/identifiers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"id": "<string>",
"system": "<string>",
"value": "<string>",
"source": "canary",
"is_primary": true,
"created_at": "2023-11-07T05:31:56Z",
"scan_values": [
{
"id": "<string>",
"payload": "<string>",
"format_hint": "<string>"
}
]
}
],
"meta": {
"request_id": "<string>",
"api_version": "<string>",
"pagination": {
"has_more": true,
"cursor": "<string>",
"total_count": 1
}
}
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}Authorizations
Organization API key with an sk_live_ or sk_test_ prefix
Query Parameters
Maximum number of items to return from a Canary-native list (1-100)
Required range:
1 <= x <= 100Pagination cursor from previous response
Sort direction
Available options:
asc, desc Allowed value:
"location"⌘I
List identifiers for a record
curl --request GET \
--url https://api.oncanary.com/v1/identifiers \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.oncanary.com/v1/identifiers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.oncanary.com/v1/identifiers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"id": "<string>",
"system": "<string>",
"value": "<string>",
"source": "canary",
"is_primary": true,
"created_at": "2023-11-07T05:31:56Z",
"scan_values": [
{
"id": "<string>",
"payload": "<string>",
"format_hint": "<string>"
}
]
}
],
"meta": {
"request_id": "<string>",
"api_version": "<string>",
"pagination": {
"has_more": true,
"cursor": "<string>",
"total_count": 1
}
}
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}