Corporations, ranks and members. Every route hangs off https://api.blixye.com/v1 and carries the key in the Authorization header (see Keys and scopes). This page is generated from the API's OpenAPI specification; if it is not here, the API does not do it.
Corporations, ranks and members. Every route hangs off https://api.blixye.com/v1 and carries the key in the Authorization header (see Keys and scopes). This page is generated from the API's OpenAPI specification; if it is not here, the API does not do it.
NOTE
Corporations, ranks and members. Every route hangs off https://api.blixye.com/v1 and carries the key in the Authorization header (see Keys and scopes). This page is generated from the API's OpenAPI specification; if it is not here, the API does not do it.
NOTE
GET /corporations: List corporations (corporations:read)
GET /corporations/{id}/ranks: Ranks of a corporation (corporations:read)
GET /corporations/{id}/members: Members of a corporation (corporations:read)
List corporations
List corporations
NOTE
List corporations
GET /corporations. Corporations (police, EMS, fire…). The internal administration corporation is not listed. Scope: corporations:read.
GET /corporations. Corporations (police, EMS, fire…). The internal administration corporation is not listed. Scope: corporations:read.
NOTE
GET /corporations. Corporations (police, EMS, fire…). The internal administration corporation is not listed. Scope: corporations:read.
Parameters:
Parameters:
NOTE
Parameters:
NOTE
limit (query; integer, 1-100, default 25, optional): Page size (1-100).
cursor (query; string, optional): The meta.next_cursor of the previous page.
order (query; string, one of: desc, asc, default desc, optional): desc = newest first.
curl "https://api.blixye.com/v1/corporations?limit=25" \
-H "Authorization: Bearer bx_live_…"
curl "https://api.blixye.com/v1/corporations?limit=25" \
-H "Authorization: Bearer bx_live_…"
NOTE
curl "https://api.blixye.com/v1/corporations?limit=25" \
-H "Authorization: Bearer bx_live_…"
Response 200: A page of corporations.
Response 200: A page of corporations.
NOTE
Response 200: A page of corporations.
{
"data": [
{
"id": "crp_3tq0vJ1c9Ydl2Hk7WqPzEw",
"name": "Los Santos Police Department",
"short_name": "LSPD",
"type": "police",
"color": "Black",
"logo_url": "https://cdn.example.com/logo.png",
"is_active": true,
"game_job": "police",
"created_at": "2026-09-27T18:04:05Z"
}
],
"meta": {
"next_cursor": "cur_3tq0vJ1c9Ydl2Hk7WqPzEw"
}
}
{
"data": [
{
"id": "crp_3tq0vJ1c9Ydl2Hk7WqPzEw",
"name": "Los Santos Police Department",
"short_name": "LSPD",
"type": "police",
"color": "Black",
"logo_url": "https://cdn.example.com/logo.png",
"is_active": true,
"game_job": "police",
"created_at": "2026-09-27T18:04:05Z"
}
],
"meta": {
"next_cursor": "cur_3tq0vJ1c9Ydl2Hk7WqPzEw"
}
}
NOTE
{
"data": [
{
"id": "crp_3tq0vJ1c9Ydl2Hk7WqPzEw",
"name": "Los Santos Police Department",
"short_name": "LSPD",
"type": "police",
"color": "Black",
"logo_url": "https://cdn.example.com/logo.png",
"is_active": true,
"game_job": "police",
"created_at": "2026-09-27T18:04:05Z"
}
],
"meta": {
"next_cursor": "cur_3tq0vJ1c9Ydl2Hk7WqPzEw"
}
}
Errors (the format is in Errors):
Errors (the format is in Errors):
NOTE
Errors (the format is in Errors):
NOTE
400: Malformed request (invalid limit, cursor, JSON, Idempotency-Key, or an API key sent in the URL).
401: Missing, invalid, revoked or expired API key (codes missing_api_key, invalid_api_key, api_key_revoked, api_key_expired).
403: The key lacks a scope (missing_scope), the IP is not allowed (ip_not_allowed), the server's plan has no API (plan_required) or an MDT module is off (module_off).
429: Too many requests for this API key (the limit is per key and per minute, by plan). Too many failed authentications from one IP also give a 429.
Ranks of a corporation
Ranks of a corporation
NOTE
Ranks of a corporation
GET /corporations/{id}/ranks. Ranks, highest first. Scope: corporations:read.
GET /corporations/{id}/ranks. Ranks, highest first. Scope: corporations:read.
NOTE
GET /corporations/{id}/ranks. Ranks, highest first. Scope: corporations:read.
Parameters:
Parameters:
NOTE
Parameters:
NOTE
id (path; string, required): Resource id.
curl "https://api.blixye.com/v1/corporations/crp_3tq0vJ1c9Ydl2Hk7WqPzEw/ranks" \
-H "Authorization: Bearer bx_live_…"
curl "https://api.blixye.com/v1/corporations/crp_3tq0vJ1c9Ydl2Hk7WqPzEw/ranks" \
-H "Authorization: Bearer bx_live_…"
NOTE
curl "https://api.blixye.com/v1/corporations/crp_3tq0vJ1c9Ydl2Hk7WqPzEw/ranks" \
-H "Authorization: Bearer bx_live_…"
Response 200: Ranks.
Response 200: Ranks.
NOTE
Response 200: Ranks.
{
"data": [
{
"id": "rnk_3tq0vJ1c9Ydl2Hk7WqPzEw",
"corporation_id": "crp_3tq0vJ1c9Ydl2Hk7WqPzEw",
"name": "Sergeant",
"short_name": "SGT",
"hierarchy": 3,
"salary": 2500,
"color": "Black",
"game_grade": 3
}
]
}
{
"data": [
{
"id": "rnk_3tq0vJ1c9Ydl2Hk7WqPzEw",
"corporation_id": "crp_3tq0vJ1c9Ydl2Hk7WqPzEw",
"name": "Sergeant",
"short_name": "SGT",
"hierarchy": 3,
"salary": 2500,
"color": "Black",
"game_grade": 3
}
]
}
NOTE
{
"data": [
{
"id": "rnk_3tq0vJ1c9Ydl2Hk7WqPzEw",
"corporation_id": "crp_3tq0vJ1c9Ydl2Hk7WqPzEw",
"name": "Sergeant",
"short_name": "SGT",
"hierarchy": 3,
"salary": 2500,
"color": "Black",
"game_grade": 3
}
]
}
Errors (the format is in Errors):
Errors (the format is in Errors):
NOTE
Errors (the format is in Errors):
NOTE
400: Malformed request (invalid limit, cursor, JSON, Idempotency-Key, or an API key sent in the URL).
401: Missing, invalid, revoked or expired API key (codes missing_api_key, invalid_api_key, api_key_revoked, api_key_expired).
403: The key lacks a scope (missing_scope), the IP is not allowed (ip_not_allowed), the server's plan has no API (plan_required) or an MDT module is off (module_off).
404: Not found in this server. An id from another server is always a 404.
429: Too many requests for this API key (the limit is per key and per minute, by plan). Too many failed authentications from one IP also give a 429.
Members of a corporation
Members of a corporation
NOTE
Members of a corporation
GET /corporations/{id}/members. Characters in the corporation, with rank. Scope: corporations:read.
GET /corporations/{id}/members. Characters in the corporation, with rank. Scope: corporations:read.
NOTE
GET /corporations/{id}/members. Characters in the corporation, with rank. Scope: corporations:read.
Parameters:
Parameters:
NOTE
Parameters:
NOTE
id (path; string, required): Resource id.
limit (query; integer, 1-100, default 25, optional): Page size (1-100).
cursor (query; string, optional): The meta.next_cursor of the previous page.
order (query; string, one of: desc, asc, default desc, optional): desc = newest first.
status (query; string, optional): active, suspended, on_leave or terminated.
curl "https://api.blixye.com/v1/corporations/crp_3tq0vJ1c9Ydl2Hk7WqPzEw/members?limit=25" \
-H "Authorization: Bearer bx_live_…"
curl "https://api.blixye.com/v1/corporations/crp_3tq0vJ1c9Ydl2Hk7WqPzEw/members?limit=25" \
-H "Authorization: Bearer bx_live_…"
NOTE
curl "https://api.blixye.com/v1/corporations/crp_3tq0vJ1c9Ydl2Hk7WqPzEw/members?limit=25" \
-H "Authorization: Bearer bx_live_…"
Response 200: A page of members.
Response 200: A page of members.
NOTE
Response 200: A page of members.
{
"data": [
{
"id": "mem_3tq0vJ1c9Ydl2Hk7WqPzEw",
"corporation_id": "crp_3tq0vJ1c9Ydl2Hk7WqPzEw",
"character_id": "chr_3tq0vJ1c9Ydl2Hk7WqPzEw",
"character_name": "John Carter",
"rank_id": "rnk_3tq0vJ1c9Ydl2Hk7WqPzEw",
"badge_number": "4521",
"callsign": "1-ADAM-12",
"status": "active",
"joined_at": "2026-09-27T18:04:05Z"
}
],
"meta": {
"next_cursor": "cur_3tq0vJ1c9Ydl2Hk7WqPzEw"
}
}
{
"data": [
{
"id": "mem_3tq0vJ1c9Ydl2Hk7WqPzEw",
"corporation_id": "crp_3tq0vJ1c9Ydl2Hk7WqPzEw",
"character_id": "chr_3tq0vJ1c9Ydl2Hk7WqPzEw",
"character_name": "John Carter",
"rank_id": "rnk_3tq0vJ1c9Ydl2Hk7WqPzEw",
"badge_number": "4521",
"callsign": "1-ADAM-12",
"status": "active",
"joined_at": "2026-09-27T18:04:05Z"
}
],
"meta": {
"next_cursor": "cur_3tq0vJ1c9Ydl2Hk7WqPzEw"
}
}
NOTE
{
"data": [
{
"id": "mem_3tq0vJ1c9Ydl2Hk7WqPzEw",
"corporation_id": "crp_3tq0vJ1c9Ydl2Hk7WqPzEw",
"character_id": "chr_3tq0vJ1c9Ydl2Hk7WqPzEw",
"character_name": "John Carter",
"rank_id": "rnk_3tq0vJ1c9Ydl2Hk7WqPzEw",
"badge_number": "4521",
"callsign": "1-ADAM-12",
"status": "active",
"joined_at": "2026-09-27T18:04:05Z"
}
],
"meta": {
"next_cursor": "cur_3tq0vJ1c9Ydl2Hk7WqPzEw"
}
}
Errors (the format is in Errors):
Errors (the format is in Errors):
NOTE
Errors (the format is in Errors):
NOTE
400: Malformed request (invalid limit, cursor, JSON, Idempotency-Key, or an API key sent in the URL).
401: Missing, invalid, revoked or expired API key (codes missing_api_key, invalid_api_key, api_key_revoked, api_key_expired).
403: The key lacks a scope (missing_scope), the IP is not allowed (ip_not_allowed), the server's plan has no API (plan_required) or an MDT module is off (module_off).
404: Not found in this server. An id from another server is always a 404.
429: Too many requests for this API key (the limit is per key and per minute, by plan). Too many failed authentications from one IP also give a 429.