Get all gender options

GET /api/configuration/genders

Success: 200 OK

Products: Operator (FOH)
Features: Front of House Generic Access (FOHGENERIC)

Overview

Lists the gender options a member record can be given. Use it to populate the gender field on a registration or profile form, and to translate the gender value on a member record back into a label.

This is one of the few lists here whose ids are genuinely stable across tenants. They are fixed — 0 Male, 1 Female, 2 Unknown, 3 Other, 4 Prefer not to say — and the descriptions are restored on every platform update, so an operator cannot permanently rename them. That makes the numeric ids safe to reason about, unlike most reference data in this API. It also means the descriptions you cache will be reset to the platform wording after a platform upgrade, so do not treat an operator's edit to them as durable.

Gender is read-only through the API: there is no create, update or delete endpoint, so the list is effectively fixed for the life of the tenant unless Gladstone adds more.

Results come back in no guaranteed order, and there is no filter and no paging. When no gender options exist you get 200 with an empty array [].

Endpoint

GET {base_url}/api/configuration/genders

{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.

Sample request

cURL

curl -X GET '{base_url}/api/configuration/genders' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'

Response fields

Field	Type	Description
`[].id`	integer (int32)	The gender's identifier, and the value held on a member record and referenced by a title. The range is 0–255 despite the `int32` shown here — and note it starts at `0`, not `1`, so a falsy-zero check will silently discard Male. The starter values are fixed rather than allocated per tenant, so `0`–`4` mean the same thing in every tenant; ids beyond that range would be allocated per tenant and are not portable.
`[].description`	string	The label to show in a picker: `Male`, `Female`, `Unknown`, `Other` or `Prefer not to say` in a default installation. Maximum 25 characters and never `null`. Gladstone restores these descriptions on every platform update, so any local edit an operator makes is temporary — render this value rather than your own wording, but key your logic on `id`.

Sample response

200 OK

[
  {
    "id": 12345,
    "description": "string"
  }
]

Errors

Status	Meaning	When
`500`	Internal server error	Any unexpected server-side failure while reading the gender options. The response is a bare status code with no body, so there is no detail to branch on. Retry with backoff; this list changes so rarely that a cached copy is a safe fallback.

This page as markdown · All pages · llms.txt