API docs

This page documents the API endpoints available on this domain. The following endpoints exist:

EndpointDescription
/api/pronounsRead/update my preferred pronouns.
/api/genderRead/update my current gender.

Pronouns

Path: /api/pronouns or /pronouns

This endpoint allows unauthenticated users to fetch my current preferred pronouns using a GET request. Authenticated users can alter the value of the preferred pronouns using a POST request with basic authorization.

Allowed methods

The following methods are allowed on this endpoint:

MethodDescriptionAuth
POSTModify the currently preferred pronouns.Basic
GETGet the currently preferred pronouns.-

Usage example

The following example demonstrates how to request the current pronouns from the command line using curl.

curl -L riley.lgbt/pronouns
they/them

Gender

Path: /api/gender or /gender

This endpoint allows unauthenticated users to fetch my current gender, and allows authenticated users to update the current gender value.

Allowed methods

The following methods are allowed on this endpoint:

MethodDescriptionAuth
POSTModify the current gender.Basic
GETGet the current gender.-

Usage example

The following example demonstrates how to request the current gender using the command line tool curl.

curl -L riley.lgbt/gender
disaster