GIgigwell
Organization

List Roster Members

Changed on

Returns the roster of the agency identified by the agencyIds path parameter, with per-artist profile attributes (genres, locations, capacity, links, bios). Each artist is keyed by entityId — the same identifier List Organization Members and Run Report use to scope a query to that artist.

The response has five sections, each controlled by a boolean in the request body (all default true): roster (agency config and per-entry agent/assistant/logistician/marketing assignments), artists (flat per-artist entries), profile (profile attributes), artistMembers, and agents. Narrow the profile payload with the profileFields allowlist; an empty or omitted list returns the full profile set. Profiles are returned, not filtered — request the fields you need, filter client-side, then pass the matching entityId values to Run Report.

Every artist carries two status flags: activeOnRoster (false = deactivated on the roster, retained only for historical reporting) and restricted (mailbox access is limited, which can narrow calendar and availability visibility). Null fields are omitted from the response.

post/agency/{agencyIds}/roster/members

Request

  • Base URL
    https://api.gigwell.com/api
  • Auth
    HTTP bearer

Path parameters

agencyIdsstring required

The agency's entity ID. Provide exactly one.

Request body

rosterboolean

Include roster config block (entries[] with per-entry agents/assistants/logisticians/marketing assignments, tags, booknow)

artistsboolean

Include artists[] flat entries (identity/contact fields plus activeOnRoster/restricted)

profileboolean

Include profiles[] (reduced field set; embedSettings excluded). An artist whose Profile failed to load is omitted from profiles[] but remains in artists[].

artistMembersboolean

Include artistMemberAccounts + invitedArtistMemberAccountRoles

agentsboolean

Include agents[] (agency agent contacts) AND per-entry agents/assistants/logisticians/marketing assignments inside roster.entries[]. When false, top-level agents is omitted and per-entry assignments become empty lists.

profileFieldsstring[] nullable

Allowlist of profile fields to include; empty or omitted returns the full profile set. Unknown names return 400.

Response

OK

status'OK' | 'FAIL' | 'ERROR'
codestring nullable

ResultCode enum name (e.g. SUCCESS, NOT_FOUND, RATE_LIMIT_EXCEEDED)

messagestring nullable

Result message: OK on success; the error text when status is FAIL or ERROR.

messagesstring[] nullable

In rare, specific cases, additional error messages.

requestIdstring nullable

A request correlation id generated by the server.

Changes

  • f761a02f0202Revision changes
    • breaking

      the response property //// became nullable for the status

    • breaking

      the /// response's property type changed from object to no type for status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • info

      api operation id getRosterForMcp removed and replaced with listRosterMembers

    • info

      the request property became nullable

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added to the /// response property allOf list for the response status

  • 97b98f94f6b6Revision changes
    • warning

      added the new bandcamp enum value to the ///// response property for the response status

    • warning

      added the new venueRosterTag enum value to the ///// response property for the response status