Skip to main content
POST
SIGEP II Entities Search

Authorizations

Authorization
string
header
required

Use Authorization: Bearer YOUR_API_KEY

Headers

Idempotency-Key
string

Optional client-chosen key for this request (any string up to 255 characters, e.g. a UUID). Every Croma operation is an idempotent lookup: repeating a request with the same body returns the same result and creates nothing, so retrying after a timeout or network failure is always safe. The key is echoed back in the Idempotency-Key response header so you can correlate a retry with its first attempt. Each attempt that reaches the API counts against the rate limit.

Maximum string length: 255
Example:

"0f8e9a42-6b7c-4d1e-9a3f-2c5d7e8f9a0b"

Body

application/json
query
string
default:""

Optional words in the entity's name, e.g. alcaldia de bogota. Empty lists every entity.

Maximum string length: 200
department
string
default:""

Optional department, as the directory names it, e.g. CÓRDOBA or BOGOTÁ. D.C.. The facets.departments[] of a search are valid values.

Maximum string length: 80
municipality
string
default:""

Optional municipality, as the directory names it, e.g. MONTERÍA. The facets.municipalities[] of a search are valid values.

Maximum string length: 80
order
enum<string>
default:""

Optional order: nacional or territorial. Empty returns both.

Available options:
,
nacional,
territorial
page
integer
default:1

1-based page number for paginated results.

Required range: 1 <= x <= 1000
per_page
integer
default:20

Results per page (1-100).

Required range: 1 <= x <= 100

Response

Successful response

data
object
required