--- agentTools: projectIndex: https://assignr-api.readme.io/llms.txt --- # /v2/current_account/users A list of users (profiles) for the currently logged in account # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Assignr API Endpoints", "version": "2.0" }, "security": [ { "assignr_oauth2_auth_code_flow": [ "read" ] }, { "assignr_oauth2_client_credentials": [ "read" ] } ], "tags": [ { "name": "Users", "description": "Officials, assignors, coaches, league contacts" } ], "paths": { "/v2/current_account/users": { "get": { "description": "A list of users (profiles) for the currently logged in account", "parameters": [ { "in": "query", "name": "search[status]", "description": "Status", "required": false, "schema": { "type": "string", "enum": [ "active", "inactive", "all" ] } }, { "in": "query", "name": "page", "description": "Page to Return.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "limit", "description": "Number of Records to Return", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 50, "default": 50 } } ], "security": [ { "assignr_oauth2_client_credentials": [ "read", "account.read" ] }, { "assignr_oauth2_auth_code_flow": [ "read", "account.read" ] } ], "responses": { "200": { "description": "A list of users (profiles) for the currently logged in account", "content": { "application/vnd.assignr.v2.hal+json": { "schema": { "$ref": "#/components/schemas/UsersRepresenter" } } } } }, "tags": [ "Users" ], "operationId": "getV2CurrentAccountUsers" } } }, "servers": [ { "url": "//api.assignr.com/api" } ], "components": { "securitySchemes": { "assignr_oauth2_client_credentials": { "type": "oauth2", "description": "Assignr/OAuth 2.0 Client Credentials Code Flow", "flows": { "clientCredentials": { "tokenUrl": "https://app.assignr.com/oauth/token", "scopes": { "read": "Read data", "write": "Write data", "licensing": "Access to Licensing data" } } } }, "assignr_oauth2_auth_code_flow": { "type": "oauth2", "description": "Assignr/OAuth 2.0 Authorization Code Flow", "flows": { "authorizationCode": { "authorizationUrl": "https://app.assignr.com/oauth/authorize", "tokenUrl": "https://app.assignr.com/oauth/token", "scopes": { "read": "Read data", "write": "Write data", "bank": "Add and remove bank accounts", "mobile": "Account actions for official Assignr mobile app" } } } } }, "schemas": { "Roar_JSON_HAL_Links_Representer": { "type": "object", "properties": { "self": { "type": "object", "properties": { "resource-type": { "description": "Type of resource", "type": "string", "example": "game" }, "href": { "description": "URL of resource", "type": "string", "example": "https://app.assignr.com/api/v1/games/123.json" } } } } }, "UsersRepresenter": { "type": "object", "properties": { "page": { "type": "object", "properties": { "records": { "description": "", "type": "string", "example": 123 }, "pages": { "description": "", "type": "string", "example": 3 }, "current_page": { "description": "", "type": "string", "example": 2 }, "next_page": { "description": "", "type": "string", "example": 3 }, "prev_page": { "description": "", "type": "string", "example": 1 }, "limit": { "description": "", "type": "string", "example": 50 } }, "description": "" }, "_links": { "$ref": "#/components/schemas/Roar_JSON_HAL_Links_Representer" }, "_embedded": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserRepresenter" }, "description": "" } } } }, "description": "UsersRepresenter model" }, "UserRepresenter": { "type": "object", "properties": { "id": { "description": "", "type": "integer", "format": "int32", "example": 123 }, "account_id": { "description": "", "type": "string", "example": 8675309 }, "last_name": { "description": "", "type": "string", "example": "Schmoe" }, "first_name": { "description": "", "type": "string", "example": "Joseph" }, "mi": { "description": "", "type": "string", "example": "Q." }, "title": { "description": "", "type": "string", "example": "Athletic Director" }, "home_phone": { "description": "", "type": "string", "example": "(585) 867-5309" }, "work_phone": { "description": "", "type": "string", "example": "(585) 867-5309" }, "mobile_phone": { "description": "", "type": "string", "example": "(585) 867-5309" }, "street1": { "description": "", "type": "string", "example": "1 Main Street" }, "street2": { "description": "", "type": "string", "example": "Apt. 12" }, "city": { "description": "", "type": "string", "example": "Rochester" }, "state": { "description": "", "type": "string", "example": "NY" }, "postal_code": { "description": "", "type": "string", "example": "14609" }, "home_phone_is_public": { "description": "", "type": "boolean", "example": true }, "work_phone_is_public": { "description": "", "type": "boolean", "example": true }, "mobile_phone_is_public": { "description": "", "type": "boolean", "example": true }, "date_of_birth": { "description": "", "type": "string", "example": "XXX XX 2001" }, "official": { "description": "", "type": "boolean", "example": true }, "assignor": { "description": "", "type": "boolean", "example": true }, "observer": { "description": "", "type": "boolean", "example": true }, "active": { "description": "", "type": "boolean", "example": true }, "email_addresses": { "type": "array", "items": { "description": "", "type": "string", "example": "joe@joeschmoe.com" } }, "created": { "description": "", "type": "string", "example": "2020-10-21T16:37:11.000-04:00" }, "updated": { "description": "", "type": "string", "example": "2020-10-21T16:37:11.000-04:00" }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "resource-type": { "description": "Resource Type", "type": "string", "example": "user" }, "href": { "description": "URI for the given resource", "type": "string", "example": "https://api.assignr.com/api/v2/users/123.json" } } } } }, "_embedded": { "type": "object", "properties": { "site": { "$ref": "#/components/schemas/Embedded_EmbeddedSiteRepresenter" }, "schools": { "type": "array", "items": { "$ref": "#/components/schemas/Embedded_EmbeddedSchoolRepresenter" }, "description": "" }, "emergency_contacts": { "type": "array", "items": { "$ref": "#/components/schemas/EmergencyContactRepresenter" }, "description": "" } } } }, "description": "UserRepresenter model" }, "Embedded_EmbeddedSiteRepresenter": { "type": "object", "properties": { "id": { "description": "", "type": "integer", "format": "int32", "example": 123 }, "name": { "description": "", "type": "string", "example": "North Cascades Referee Alliance" }, "created": { "description": "", "type": "string", "example": "2020-10-21T16:37:11.000-04:00" }, "updated": { "description": "", "type": "string", "example": "2020-10-21T16:37:11.000-04:00" }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "resource-type": { "description": "Resource Type", "type": "string", "example": "site" }, "href": { "description": "URI for the given resource", "type": "string", "example": "https://api.assignr.com/api/v2/sites/123.json" } } } } } } }, "Embedded_EmbeddedSchoolRepresenter": { "type": "object", "properties": { "id": { "description": "", "type": "integer", "format": "int32", "example": 123 }, "name": { "description": "", "type": "string", "example": "Brighton HS" }, "created": { "description": "", "type": "string", "example": "2020-10-21T16:37:11.000-04:00" }, "updated": { "description": "", "type": "string", "example": "2020-10-21T16:37:11.000-04:00" }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "resource-type": { "description": "Resource Type", "type": "string", "example": "school" }, "href": { "description": "URI for the given resource", "type": "string", "example": "https://api.assignr.com/api/v2/schools/123.json" } } } } } } }, "EmergencyContactRepresenter": { "type": "object", "properties": { "id": { "description": "", "type": "integer", "format": "int32", "example": 123 }, "name": { "description": "", "type": "string", "example": "Leslie Higgins" }, "relationship": { "description": "", "type": "string", "example": "Father" }, "phone_number": { "description": "", "type": "string", "example": "(585) 555-1212" }, "email_address": { "description": "", "type": "string", "example": "hello@example.com" }, "account_email": { "description": "", "type": "string", "example": true }, "text": { "description": "", "type": "string", "example": "Park in the north parking lot next to the football stands" }, "html": { "description": "", "type": "string", "example": "

Park in the north parking lot next to the football stands

" }, "created": { "description": "", "type": "string", "example": "2020-10-21T16:37:11.000-04:00" }, "updated": { "description": "", "type": "string", "example": "2020-10-21T16:37:11.000-04:00" }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "resource-type": { "description": "Resource Type", "type": "string", "example": "emergency_contact" }, "href": { "description": "URI for the given resource", "type": "string", "example": "https://api.assignr.com/api/v2/emergency_contacts/123.json" } } } } } }, "description": "EmergencyContactRepresenter model" } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true }, "_id": { "buffer": { "0": 96, "1": 18, "2": 244, "3": 62, "4": 88, "5": 249, "6": 244, "7": 0, "8": 129, "9": 148, "10": 5, "11": 110 } } } ```