Get a specific gender option by ID
GET /api/configuration/genders/{genderId}
Success: 200 OK
- Products: Operator (
FOH) - Features: Front of House Generic Access (
FOHGENERIC)
Overview
Returns one gender option — the small reference list that member titles and member profiles are categorised against.
A gender that does not exist returns 400, not 404. The lookup returns nothing, and the endpoint reports that as a bad request with the plain string GetGender could not find the id {genderId}. Do not treat 404 as "no such gender"; it will not be sent. If you need to distinguish "unknown id" from "malformed request", read the body.
Gender options are configured per tenant and are not part of a fixed global list, so the ids are only meaningful within the environment you are calling. Take them from the list-genders endpoint or from a title's genderId rather than assuming a numbering.
Endpoint
GET {base_url}/api/configuration/genders/{genderId}
{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
genderId | integer (int32) | Yes | The gender's identifier, as returned by the list-genders endpoint or as the genderId on a title. Only whole numbers from 0 to 255 are accepted — a larger or negative number returns 400 before any lookup happens. An in-range id that matches no gender also returns 400. |
Sample request
curl -X GET '{base_url}/api/configuration/genders/{genderId}' \
-H 'Authorization: Bearer {accessToken}' \
-H 'X-Use-SSO: true'Response fields
| Field | Type | Description |
|---|---|---|
id | integer (int32) | The identifier you requested, echoed back. This is the value to store against a member or to match against a title's genderId; it is specific to the tenant, so do not carry it between environments. |
description | string | Maximum 25 characters. |
Sample response
{
"id": 12345,
"description": "string"
}Errors
| Status | Meaning | When |
|---|---|---|
400 | Bad request | No gender has that id. The body is the plain string GetGender could not find the id {genderId} — this is the response you get for a missing record, in place of a 404. |
400 | Bad request | genderId is invalid — it is not a whole number, or it falls outside 0 to 255. The body is a validation error object keyed by field name rather than a plain string. |
404 | Not found | Not returned by this endpoint — a missing gender returns 400. |
500 | Internal server error | The lookup itself failed. The body is empty. |