curl --request GET \
--url https://{organization}.rescueconsole.com/api/registry/flags/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/registry/flags/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/registry/flags/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "<string>",
"originating_tenant_id": "<string>",
"subject_type": "person",
"identifiers": {
"microchip_hash": "<string>",
"email_hash": "<string>",
"phone_hash": "<string>",
"phone_hash_national": "<string>",
"phone_country": "<string>",
"name_parts": {
"prefix": "<string>",
"first": "<string>",
"last": "<string>",
"suffix": "<string>"
},
"name_alias": "<string>",
"animal_name": "<string>",
"species": "<string>",
"breed": "<string>",
"color": "<string>",
"sex": "<string>",
"address_area": {
"city": "<string>",
"administrative_area": "<string>",
"country": "<string>"
},
"dob_year": "<string>",
"dob_hash": "<string>"
},
"flag_type": "animal_abuse",
"severity": "advisory",
"status": "pending_review",
"visibility": "network",
"narrative": "<string>",
"evidence_refs": [
"<unknown>"
],
"moderation_metadata": {
"corroborations": 123,
"disputes": 123,
"insufficient_evidence": 123,
"corroborating_tenant_ids": [
"<string>"
],
"disputing_tenant_ids": [
"<string>"
]
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"originating_organization": {
"name": "<string>",
"slug": "<string>",
"contact_email": "<string>",
"contact_phone": "<string>"
}
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Get one flag
One flag in full, with the organization that filed it. You can read any flag your organization filed, in any status. A flag another organization filed can be read when its visibility is network and it is active, or when it is still pending review and your key may review flags (write on Registry): that is the flag your organization was asked to review. Any other flag answers 404, the same as a flag that does not exist. A pending flag is not a finding: nobody has corroborated it, and no search returns it. Needs read on Registry.
curl --request GET \
--url https://{organization}.rescueconsole.com/api/registry/flags/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/registry/flags/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/registry/flags/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "<string>",
"originating_tenant_id": "<string>",
"subject_type": "person",
"identifiers": {
"microchip_hash": "<string>",
"email_hash": "<string>",
"phone_hash": "<string>",
"phone_hash_national": "<string>",
"phone_country": "<string>",
"name_parts": {
"prefix": "<string>",
"first": "<string>",
"last": "<string>",
"suffix": "<string>"
},
"name_alias": "<string>",
"animal_name": "<string>",
"species": "<string>",
"breed": "<string>",
"color": "<string>",
"sex": "<string>",
"address_area": {
"city": "<string>",
"administrative_area": "<string>",
"country": "<string>"
},
"dob_year": "<string>",
"dob_hash": "<string>"
},
"flag_type": "animal_abuse",
"severity": "advisory",
"status": "pending_review",
"visibility": "network",
"narrative": "<string>",
"evidence_refs": [
"<unknown>"
],
"moderation_metadata": {
"corroborations": 123,
"disputes": 123,
"insufficient_evidence": 123,
"corroborating_tenant_ids": [
"<string>"
],
"disputing_tenant_ids": [
"<string>"
]
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"originating_organization": {
"name": "<string>",
"slug": "<string>",
"contact_email": "<string>",
"contact_phone": "<string>"
}
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Authorizations
An API key from Settings, API keys. It starts with rc_live_.
Path Parameters
The flag's ID.
Response
The flag.
The ID of the organization that filed it.
Whether the flag is about a person or an animal.
person, animal The identifiers as they are kept. Only the keys the flag was filed with are present.
Show child attributes
Show child attributes
animal_abuse, neglect, fraud, abandonment, falsified_application, other advisory, moderate, severe pending_review until two other organizations corroborate it (then active), or two dispute it (then disputed). Nothing sets revoked at present.
pending_review, active, disputed, revoked network: other organizations can see it once it is active. private: only your organization ever sees it.
network, private The tally of other organizations' reviews.
Show child attributes
Show child attributes
Who filed it. Null if that organization can no longer be found.
Show child attributes
Show child attributes