List current club memberships for the logged in user for a specific club. If current_memberships_only is set to "F", all user memberships (past, current, and future) memberships will be included.
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
format |
GET | xml | Format of response. The default if not sent is `xml`, but `json` is preferred. | format |
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
club_idRequired |
GET | ID of club. | uint |
|
current_memberships_only |
GET | T | Should only current membership be returned? | bool |
include_questions |
GET | F | Should questions be included? | bool |
supports_nb |
GET | F | Does integration support non-binary X gender? | bool |
{
"openapi": "3.0.3",
"info": {
"title": "Memberships For Logged In User In a Specific Club",
"description": "List memberships for the logged in user in a specific club.",
"version": "1.0.0",
"contact": {
"name": "RunSignup API Support",
"url": "https://runsignup.com/API",
"email": "info@runsignup.com"
}
},
"servers": [
{
"url": "https://api.runsignup.com/rest",
"description": "Production API Server"
}
],
"tags": [
{
"name": "Club Memberships",
"description": "APIs related to Club Memberships"
}
],
"components": {
"schemas": {
"Error": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Error message"
},
"details": {
"type": "object",
"description": "Additional error details",
"additionalProperties": true
}
},
"required": [
"error"
]
},
"BadRequestError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating invalid request parameters or structure"
}
]
},
"UnauthorizedError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating authentication failure"
}
]
},
"ForbiddenError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating the authenticated user lacks required permissions"
}
]
},
"NotFoundError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating the requested resource does not exist"
}
]
},
"ServerError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating an unexpected server-side issue"
}
]
}
},
"securitySchemes": {
"apiKey": {
"type": "apiKey",
"in": "query",
"name": "api_key",
"description": "RunSignup API Key"
},
"apiSecret": {
"type": "apiKey",
"in": "query",
"name": "api_secret",
"description": "RunSignup API Secret"
}
}
},
"paths": {
"/club/{club_id}/members/mine": {
"get": {
"tags": [
"Club Memberships"
],
"summary": "Memberships For Logged In User In a Specific Club",
"description": "List memberships for the logged in user in a specific club.",
"operationId": "club_:club_id_members_mine",
"parameters": [
{
"name": "club_id",
"in": "path",
"description": "Path parameter: club_id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "format",
"in": "query",
"description": "Format of response. The default if not sent is `xml`, but `json` is preferred.",
"required": false,
"schema": {
"type": "string",
"enum": [
"xml",
"json",
"csv"
],
"default": "xml"
}
},
{
"name": "current_memberships_only",
"in": "query",
"description": "Should only current membership be returned?",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "T"
}
},
{
"name": "include_questions",
"in": "query",
"description": "Should questions be included?",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "supports_nb",
"in": "query",
"description": "Does integration support non-binary X gender?",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
}
],
"security": [
{
"apiKey": [],
"apiSecret": []
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerError"
}
}
}
}
},
"x-permissions": []
}
}
}
}
