Falken
  1. OrganizationUsers
Falken
  • Athletes
    • Returns all athletes.
      GET
    • Creates a new athlete.
      POST
    • Returns a single athlete by ID.
      GET
    • Updates an existing athlete.
      PUT
    • Deletes an athlete.
      DELETE
  • FalkenAI
    • Detect the predominant language of the supplied text.
      POST
    • Perform sentiment analysis on the supplied text.
      POST
    • Extract key phrases from the supplied text.
      POST
    • Upload an image and receive a descriptive caption.
      POST
    • Chat with the OpenAI assistant.
      POST
    • Legacy text completion.
      POST
    • Generate embeddings for the given text.
      POST
    • Moderate content.
      POST
    • Generate image(s) from a text prompt.
      POST
    • Transcribe an audio file using Whisper.
      POST
    • Translate an audio file to English.
      POST
    • List available OpenAI models.
      GET
  • Me
    • Returns every active organization-role assignment for the signed-in user.
      GET
  • NewsArticle
    • Get all news articles for an organization.
      GET
    • Create a new news article.
      POST
    • Get a specific news article by ID.
      GET
    • Update an existing news article.
      PUT
    • Delete a news article.
      DELETE
    • Get a specific news article by slug.
      GET
    • Publish a news article.
      POST
    • Get trending news articles for an organization.
      GET
    • Track a view for a news article.
      POST
    • Upload a featured image for a news article.
      POST
  • NewsAuthor
    • Get all news authors for an organization.
    • Create a new news author for the current user.
    • Get a specific news author by ID.
    • Update an existing news author.
    • Delete a news author.
    • Get the author profile for the current user in this organization.
  • NewsCategory
    • Get all news categories for an organization.
    • Create a new news category.
    • Get a specific news category by ID.
    • Update an existing news category.
    • Delete a news category.
    • Get a specific news category by slug.
  • OrganizationAddresses
    • /api/organizations/{organizationId}/addresses
    • /api/organizations/{organizationId}/addresses
    • /api/organizations/{organizationId}/addresses/{id}
    • /api/organizations/{organizationId}/addresses/{id}
    • /api/organizations/{organizationId}/addresses/{id}
    • List all organization addresses globally.
    • List organization addresses filtered by Falken.Axios.Enums.AddressType.
  • OrganizationContacts
    • /api/organizations/{organizationId}/contacts
    • /api/organizations/{organizationId}/contacts
    • /api/organizations/{organizationId}/contacts/{id}
    • /api/organizations/{organizationId}/contacts/{id}
    • /api/organizations/{organizationId}/contacts/{id}
  • OrganizationLogos
    • Returns all logos for an organization (public).
    • Uploads a new logo (admin only).
    • Returns logos of a specific logoType for an organization (public).
    • Returns a single logo by its ID (public).
    • Delete a logo (admin only).
    • Permanently delete a logo and its blob (admin only).
  • OrganizationRosters
    • /api/organizations/{organizationId}/roster
    • /api/organizations/{organizationId}/roster
    • /api/organizations/{organizationId}/roster/{id}
    • /api/organizations/{organizationId}/roster/{id}
    • /api/organizations/{organizationId}/roster/{id}
    • /api/organizations/{organizationId}/roster/search
  • Organizations
    • Get all organizations (public endpoint).
    • Create a new organization (admin only).
    • Get all organizations for a specific organization type.
    • Get an organization by ID (public endpoint).
    • Update an organization (admin only).
    • Delete an organization (admin only).
  • OrganizationTeams
    • /api/organizations/{organizationId}/teams
    • /api/organizations/{organizationId}/teams
    • /api/organizations/{organizationId}/teams/{id}
    • /api/organizations/{organizationId}/teams/{id}
    • /api/organizations/{organizationId}/teams/{id}
    • /api/organizations/{organizationId}/teams/{teamId}/members
    • /api/organizations/{organizationId}/teams/{teamId}/members
    • /api/organizations/{organizationId}/teams/{teamId}/members/{memberId}
    • /api/organizations/{organizationId}/teams/{teamId}/members/{memberId}
    • /api/organizations/{organizationId}/teams/search
  • OrganizationTypes
    • Get all organization types (public endpoint).
    • Create a new organization type (admin only).
    • Get an organization type by ID (public endpoint).
    • Update an organization type (admin only).
    • Delete an organization type (admin only).
  • OrganizationUsers
    • Get all users and their roles for an organization.
      GET
    • Get roles for a specific user in an organization.
      GET
    • Assign a role to a user in an organization.
      POST
    • Remove a role from a user in an organization.
      DELETE
    • Get all available roles that can be assigned.
      GET
  • Password
    • Returns whether the authenticated user can change their password via the UI.
    • /api/user/password/change
  • ReservedTerm
    • Get all reserved terms.
    • Create a new reserved term.
    • Get reserved terms for a specific scope.
    • Get a specific reserved term by ID.
    • Update an existing reserved term.
    • Delete a reserved term.
    • Validate content against reserved terms.
  • SocialMediaProvider
    • Get all social media providers.
    • Create a new social media provider.
    • Get all active social media providers.
    • Get a specific social media provider by ID.
    • Update an existing social media provider.
    • Delete a social media provider.
  • UserAvatars
    • Upload an avatar image. Only jpg, png and webp are allowed.
    • Get all avatars for a user (self or admin only).
    • Upload an avatar image. Only jpg, png and webp are allowed.
    • Get all avatars for a user (self or admin only).
    • Delete an avatar (soft delete). Only the user or an admin may delete.
    • Delete an avatar (soft delete). Only the user or an admin may delete.
    • Permanently delete an avatar (admin only).
    • Permanently delete an avatar (admin only).
    • Mark an avatar as the current profile image (self or admin).
    • Mark an avatar as the current profile image (self or admin).
  • UserProfiles
    • Get all user profiles (admin only)
    • Create a profile (user or admin).
    • Get the current user's profile.
    • Update a profile. Users may update self; admins may update any.
    • Delete a profile (admin only).
  • VanityUrl
    • Checks whether the supplied vanity URL is valid.
  • AthleteProfileImage
    • Uploads a profile image for the specified athlete.
    • Gets all profile images for the specified athlete.
    • Gets a specific profile image by its ID.
    • Deletes a profile image.
    • Gets a profile image by athlete ID and image type.
  • AthleteSocialMediaProfiles
    • Gets all social media profiles for a specific athlete.
    • Creates a new social media profile for an athlete.
    • Gets a specific social media profile by ID.
    • Updates an existing social media profile.
    • Deletes a social media profile.
  • Competition
    • Gets all competitions.
    • Creates a new competition.
    • Gets a competition by its unique identifier.
    • Updates an existing competition.
    • Deletes a competition.
    • Gets competitions by league season ID.
  • Conference
    • Gets all conferences for a specific league.
    • Creates a new conference.
    • Gets all divisions for a specific conference.
    • Gets a conference by its unique identifier.
    • Updates an existing conference.
    • Deletes a conference.
  • Contacts
    • Imports a bulk list of contacts for an organization.
    • Gets all contacts for an organization.
    • Gets a single contact by ID.
    • Updates an existing contact.
    • Deletes a contact.
    • Creates a new contact for an organization.
  • CorporateSponsors
    • Gets all corporate sponsors for a specific campaign.
    • Gets a specific corporate sponsor by ID.
    • Updates a corporate sponsor.
    • Deletes a corporate sponsor.
  • Disciplines
    • Get all disciplines.
    • Create a new discipline.
    • Get a discipline by ID.
    • Update an existing discipline.
    • Delete a discipline.
  • Division
    • Gets all divisions for a specific conference.
    • Creates a new division.
    • Gets a division by its unique identifier.
    • Updates an existing division.
    • Deletes a division.
  • FundraisingCampaigns
    • Creates a new fundraising campaign.
    • Lists campaigns by scope for an organization.
    • Updates an existing fundraising campaign.
    • Deletes a fundraising campaign.
    • Gets a specific fundraising campaign by ID.
    • Adds a corporate sponsor to a campaign.
    • Gets campaign statistics including total raised and progress.
  • FundraisingContactDNC
    • Adds a contact to the Do Not Contact list. This endpoint can be called by users who want to opt out of fundraising communications.
    • Removes a contact from the Do Not Contact list. This endpoint allows users to opt back into fundraising communications.
    • Checks if an email is on the Do Not Contact list.
    • Gets all Do Not Contact records (Admin only).
  • FundraisingEmployerOrganizations
    • Gets all fundraising employer-organization relationships.
    • Creates a new fundraising employer-organization relationship.
    • Gets fundraising employer-organization relationships for a specific employer.
    • Gets fundraising employer-organization relationships for a specific organization.
    • Gets a specific fundraising employer-organization relationship by ID.
    • Updates an existing fundraising employer-organization relationship.
    • Deletes a fundraising employer-organization relationship.
  • FundraisingEmployers
    • Gets all fundraising employers.
    • Creates a new fundraising employer.
    • Gets a specific fundraising employer by ID.
    • Updates an existing fundraising employer.
    • Deletes a fundraising employer.
  • League
    • Gets all leagues.
    • Creates a new league.
    • Gets a league by its unique identifier.
    • Updates an existing league.
    • Deletes a league.
  • Range
    • Gets all ranges.
    • Creates a new range.
    • Gets a range by its unique identifier.
    • Updates an existing range.
    • Deletes a range.
    • Gets ranges by organization ID.
    • Updates a range's online status.
    • Gets all firing points for a range.
    • Creates a new firing point for a range.
    • Gets a firing point by its unique identifier.
    • Updates an existing firing point.
    • Deletes a firing point.
    • Updates a firing point's online status.
  • Rulebooks
    • Get all rulebooks.
    • Create a new rulebook.
    • Get a rulebook by ID.
    • Update an existing rulebook.
    • Delete a rulebook.
    • Get all versions of a rulebook.
    • Create a new version of a rulebook.
    • Publish a specific version of a rulebook.
  • RulebookVersions
    • Get a specific rulebook version by ID.
  • SanctioningBody
    • Create a new sanctioning body, optionally with a logo upload.
    • Get all sanctioning bodies.
    • Create a new sanctioning body.
    • Get all active sanctioning bodies.
    • Update an existing sanctioning body, optionally with a new logo.
    • Get a specific sanctioning body by ID.
    • Update an existing sanctioning body.
    • Delete a sanctioning body (soft delete - sets state to Deleted).
    • Upload and set the logo for an existing sanctioning body.
  • TargetScoring
    • Scores a paper target image using computer vision.
  1. OrganizationUsers

Get roles for a specific user in an organization.

GET
https://api.falken.ltd/api/organizations/{organizationId}/users/{auth0UserId}
Last modified:2025-07-07 15:59:21
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.falken.ltd/api/organizations//users/'
Response Response Example
[
    {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
        "organization": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "acronym": "string",
            "shortName": "string",
            "slug": "string",
            "description": "string",
            "websiteUrl": "string",
            "vanityUrl": "string",
            "mascot": "string",
            "stateOrTerritory": 1,
            "country": 0,
            "created": "2019-08-24T14:15:22Z",
            "updated": "2019-08-24T14:15:22Z",
            "isDeleted": true,
            "organizationTypeId": "7504c607-cbd4-461e-b9f7-711ec42cf8bd",
            "organizationType": {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "name": "string",
                "slug": "string",
                "description": "string",
                "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
                "displayOrder": 0,
                "created": "2019-08-24T14:15:22Z",
                "updated": "2019-08-24T14:15:22Z",
                "isDeleted": true,
                "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
                "updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e",
                "parent": {},
                "children": [
                    {}
                ]
            },
            "parentOrganizationId": "63f6c742-ce8a-40d9-97e1-7492d05907db",
            "parentOrganization": {},
            "childOrganizations": [
                {}
            ],
            "addresses": [
                {
                    "addressLine1": "string",
                    "addressLine2": "string",
                    "city": "string",
                    "state": 1,
                    "postalCode": "string",
                    "country": 0,
                    "latitude": -90,
                    "longitude": -180,
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
                    "organization": {},
                    "addressType": 0,
                    "created": "2019-08-24T14:15:22Z",
                    "updated": "2019-08-24T14:15:22Z"
                }
            ],
            "logos": [
                {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
                    "organization": {},
                    "logoType": 0,
                    "blobName": "string",
                    "url": "string",
                    "width": 0,
                    "height": 0,
                    "fileSizeBytes": 0,
                    "contentType": "string",
                    "uploadedAtUtc": "2019-08-24T14:15:22Z",
                    "eTag": "string",
                    "rowVersion": "string"
                }
            ]
        },
        "auth0UserId": "string",
        "organizationRoleId": "3ed06bb5-3877-4ce1-8371-c21273b858f1",
        "organizationRole": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "slug": "string",
            "description": "string",
            "displayOrder": 0,
            "isSystemRole": true,
            "created": "2019-08-24T14:15:22Z",
            "updated": "2019-08-24T14:15:22Z",
            "organizationUsers": [
                {}
            ]
        },
        "startDate": "2019-08-24T14:15:22Z",
        "endDate": "2019-08-24T14:15:22Z",
        "notes": "string",
        "created": "2019-08-24T14:15:22Z",
        "updated": "2019-08-24T14:15:22Z",
        "isActive": true
    }
]

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
organizationId
string <uuid>
required
auth0UserId
string 
required

Responses

🟢200OK
text/plain
OK
Body
array of:
id
string <uuid>
optional
Primary key for the OrganizationUser record.
organizationId
string <uuid>
required
The ID of the organization.
organization
object (Falken.Echelon.Data.Entities.Organizations.Organization) 
optional
Represents an organization such as a school, club, business, or JROTC unit.
id
string <uuid>
optional
name
string 
required
Full, legal, or display name.
>= 1 characters<= 200 characters
acronym
string 
required
Required acronym or common shorthand (e.g., “NCSU”).
>= 1 characters<= 100 characters
shortName
string 
required
Required short name used in tables or badges.
>= 1 characters<= 100 characters
slug
string 
read-onlyrequired
URL-friendly, unique slug. Auto-generated from Falken.Echelon.Data.Entities.Organizations.Organization.Name, state, and country.
>= 1 characters<= 256 characters
description
string  | null 
optional
<= 2000 characters
websiteUrl
string  | null 
optional
<= 500 characters
vanityUrl
string  | null 
optional
Optional vanity URL segment unique within Falken.
Normalised to lower-case with only a-z, 0-9, and “-”.
<= 100 characters
mascot
string 
required
Required mascot / symbol (e.g., “Titans”).
>= 1 characters<= 100 characters
stateOrTerritory
enum<integer> <int32>
optional
Allowed values:
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
country
enum<integer> <int32>
optional
Allowed values:
0123456789101112131415161718192021222324
created
string <date-time>
optional
updated
string <date-time>
optional
isDeleted
boolean 
optional
organizationTypeId
string <uuid>
required
organizationType
object (Falken.Echelon.Data.Entities.Organizations.OrganizationType) 
optional
Represents a hierarchical classification of organizations (e.g., High School, University, JROTC branches).
Supports parent/child relationships for building organizational taxonomies.
parentOrganizationId
string <uuid> | null 
optional
Optional parent organization (for hierarchical relationships).
parentOrganization
object (Falken.Echelon.Data.Entities.Organizations.Organization) 
optional
Represents an organization such as a school, club, business, or JROTC unit.
childOrganizations
array[object (Falken.Echelon.Data.Entities.Organizations.Organization) {21}]  | null 
optional
Child organizations that reference this organization as their parent.
addresses
array[object (Falken.Echelon.Data.Entities.Organizations.OrganizationAddress) {14}]  | null 
optional
Addresses associated with this organization.
logos
array[object (Falken.Echelon.Data.Entities.Organizations.OrganizationLogo) {13}]  | null 
optional
Logos associated with this organization.
auth0UserId
string 
required
The Auth0 user identifier.
>= 1 characters<= 64 characters
organizationRoleId
string <uuid>
required
The ID of the role assigned to this user in this organization.
organizationRole
object (Falken.Echelon.Data.Entities.Organizations.OrganizationRole) 
optional
Represents a role that can be assigned to users within an organization.
Examples: Athlete, Parent, Coach, SocialMediaCoordinator, NewsAuthor, TechnicalDirector, OrgAdmin.
id
string <uuid>
optional
Primary key for the OrganizationRole record.
name
string 
required
The name of the role (e.g., "Athlete", "Coach", "OrgAdmin").
>= 1 characters<= 100 characters
slug
string 
required
URL-friendly identifier for the role.
>= 1 characters<= 100 characters
description
string  | null 
optional
Optional description of what this role entails.
<= 500 characters
displayOrder
integer <int32>
optional
Display order for sorting roles in UI.
isSystemRole
boolean 
optional
Whether this is a system-defined role that cannot be deleted.
created
string <date-time>
optional
UTC timestamp when the role was created.
updated
string <date-time>
optional
UTC timestamp when the role was last updated.
organizationUsers
array[object (Falken.Echelon.Data.Entities.Organizations.OrganizationUser) {12}]  | null 
optional
Navigation property to organization users with this role.
startDate
string <date-time>
required
The date when this role assignment became effective.
endDate
string <date-time> | null 
optional
The date when this role assignment expires or was revoked.
If null, the role assignment is still active.
notes
string  | null 
optional
Optional notes about this role assignment.
<= 1000 characters
created
string <date-time>
optional
UTC timestamp when the role assignment was created.
updated
string <date-time>
optional
UTC timestamp when the role assignment was last updated.
isActive
boolean 
read-onlyoptional
Indicates whether the role assignment is currently active (EndDate is null or in the future).
Modified at 2025-07-07 15:59:21
Previous
Get all users and their roles for an organization.
Next
Assign a role to a user in an organization.
Built with