Skip to main content

ListRosterMembersResponse

statusstring

Possible values: [OK, FAIL, ERROR]

codestringnullable

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

messagestringnullable

Error message, present when status is FAIL or ERROR.

messagesstring[]nullable

In rare, specific cases, additional error messages.

data object
identityIdstring
titlestring
webtitlestring
avatarImageUrlstring
profileImageUrlstring
bannerImageUrlstring
roster object
idstring
entries object[]
  • Array [
  • sortOrderinteger
    entityIdstring
    agents object[]
  • Array [
  • accountIdstring
    autoAddboolean
  • ]
  • assistants object[]
  • Array [
  • accountIdstring
    autoAddboolean
  • ]
  • logisticians object[]
  • Array [
  • accountIdstring
    autoAddboolean
  • ]
  • marketing object[]
  • Array [
  • accountIdstring
    autoAddboolean
  • ]
  • tagsstring[]
    activeOnRosterboolean
    marketplaceboolean
    booknowboolean
    restrictedboolean
    riderIdstring
    createdDatestring
    updatedDatestring
  • ]
  • entryCountinteger
    autoAlphaSortboolean
    agentsCanUseShowBookingboolean
    agentsCanEditRestrictedBookingboolean
    agentsHaveFullAccessboolean
    newArtistsBooknowboolean
    restrictedMailboxAccessboolean
    showInactiveArtistsboolean
    entityIdsSharingArtistsstring[]
    createdDatestring
    updatedDatestring
    artists object[]
  • Array [
  • entityIdstring
    titlestring
    webtitlestring
    emailstring
    legalTitlestring
    phoneNumberstring
    avatarImageUrlstring
    profileImageUrlstring
    booknowboolean
    tagsstring[]
    activeOnRosterboolean
    restrictedboolean
  • ]
  • profiles object[]
  • Array [
  • entityIdstring
    titlestring
    webtitlestring
    biographystring
    genresstring[]
    labelsstring[]
    hashtagstring
    socialNetworks object[]
  • Array [
  • namestring

    Possible values: [amazonMusic, appleMusic, bandsintown, beatport, bilibili, deezer, discogs, douyin, facebook, instagram, kuaishou, mixcloud, pandora, patreon, residentAdvisor, reverbNation, shazam, songkick, soundcloud, spotify, tidal, thedjlist, tiktok, toutiao, traxsource, twitch, twitter, website, weibo, wikipedia, youtube]

    usernamestring
    useridstring
    urlstring
    countinteger
    displayedboolean
    orderinteger
  • ]
  • profileImagesstring[]
    avatarImageUrlstring
    profileImageUrlstring
    profileHeaderImageUrlstring
    bannerImageUrlstring
    discographyUrlstring
    presskitlinkstring
    techriderlinkstring
    presskitimagestring
    quotesstring[]
    affiliationsstring
    nationalitystring
    citystring
    countrystring
    countryNamestring
    hometownstring
    customFields object[]
  • Array [
  • valuesstring[]
    entityIdstring
    presetTypestring

    Possible values: [accountFilter, advanceSheetTemplate, advancing, agencyAnalyticsFilterentity, agencyAnalyticsFilteraccount, allArtistsCalendar, airline, artistExpenses, artistExpenseType, bedSize, bookNowSettings, bookingPresets, bookingReportsFilter, billedAs, billingType, blockedReason, buyerExpenses, buyerExpenseType, bookingFields, calendars, calendarStreamFilterentity, calendarStreamFilteraccount, cannedMessages, contractTermsType, contractTermsPhrases, customInvoiceIdSequences, customLogisticsConfig, customLogisticsPresets, currencies, csvReportPreset, disposition, distanceUnit, documentPacket, dynamicPdfReportPreset, enabledFeatures, entityAssetsTag, entityLegalAssetsTag, entityFilter, entityNotificationSettings, eSignSettings, events, eventSchedule, eventScheduleActor, eventScheduleLocation, eventScheduleType, eventType, eventCalendarFilterentity, eventDetailPresets, eventReportsFilter, expensesReportsFilter, gigstreamSettings, groundSpecialRequests, hotelSpecialRequests, htmlDocsSettings, inboundEmailMessageFilter, incomeTaxRateSettings, internalStatus, invoiceDistributionItemReportsFilter, invoiceReportsFilter, invoiceItemReportsFilter, invoices, invoiceItemLabels, itinerary, itineraryRequestSettings, itinerarySettings, jsonReportPreset, logisticsPhrases, logisticsType, merchSeller, minimumAge, mailboxFilterentity, mailboxFilteraccount, offer, outboundEmailMessageFilter, paymentPlan, paymentConfig, profileCustom1, profileCustom2, profileCustom3, profileCustom4, profileCustom5, profileFields, profileGenre, profileLabel, profileEmbedSettings, performanceType, radiusClausePreset, rating, reportColumnsPreset, resourceFilter, roomType, rosterTag, rosterEmbedSettings, settlementReportsFilter, settlementMessageReportsFilter, seating, signUpFilter, smoking, summaryViewConfig, summaryViewPermissions, taskPresets, taskFilter, taskReportsFilter, taxRates, teamPresets, ticketFees, ticketFeeType, ticketScale, ticketType, timeUnit, travelSpecialRequests, travelType, vehicleType, venueAssetsTag, venueCalendars, venueLegalAssetsTag, exportFilter]

  • ]
  • activeOnRosterboolean
    restrictedboolean
    soundcloudmedia object[]
  • Array [
  • fullWidthboolean
    namestring
    stream_urlstring
    urlstring
    validation object
    errorstring

    Possible values: [INVALID_URL, UNAUTHORIZED, NOT_FOUND, UNSUPPORTED_TYPE]

    statusstring

    Possible values: [VALID, WARNING, INVALID]

    dateTimestring
    providerNamestring
    typestring

    Possible values: [photo, video, rich, link, error]

  • ]
  • mixcloudmedia object[]
  • Array [
  • fullWidthboolean
    namestring
    stream_urlstring
    urlstring
    validation object
    errorstring

    Possible values: [INVALID_URL, UNAUTHORIZED, NOT_FOUND, UNSUPPORTED_TYPE]

    statusstring

    Possible values: [VALID, WARNING, INVALID]

    dateTimestring
    providerNamestring
    typestring

    Possible values: [photo, video, rich, link, error]

  • ]
  • youtubemedia object[]
  • Array [
  • fullWidthboolean
    namestring
    stream_urlstring
    urlstring
    validation object
    errorstring

    Possible values: [INVALID_URL, UNAUTHORIZED, NOT_FOUND, UNSUPPORTED_TYPE]

    statusstring

    Possible values: [VALID, WARNING, INVALID]

    dateTimestring
    providerNamestring
    typestring

    Possible values: [photo, video, rich, link, error]

  • ]
  • reachinteger
    customReachinteger
    capacityinteger
    thedjlistrankinteger
    ownerstring
    displayTitlestring
    multimedia object[]
  • Array [
  • fullWidthboolean
    namestring
    stream_urlstring
    urlstring
    validation object
    errorstring

    Possible values: [INVALID_URL, UNAUTHORIZED, NOT_FOUND, UNSUPPORTED_TYPE]

    statusstring

    Possible values: [VALID, WARNING, INVALID]

    dateTimestring
    providerNamestring
    typestring

    Possible values: [photo, video, rich, link, error]

  • ]
  • updatedDatestring
    createdDatestring
  • ]
  • artistMemberAccounts object
    property name* object[]
  • Array [
  • identityIdstring

    The member account's identity ID within the artist entity.

    rolesstring[]

    The member's roles within the artist entity: artist, owner, manager, affiliate, associate, or invited (pending invite).

    Possible values: [artist, owner, manager, affiliate, associate, invited]

    activeboolean

    Whether the membership is active.

    titlestring

    Display title of the member within this artist entity.

  • ]
  • invitedArtistMemberAccountRoles object
    property name* object
    property name* string[]
  • Array [
  • string
  • ]
  • agents object[]
  • Array [
  • idstring

    Unique identifier of the member's Gigwell account.

    firstNamestring

    Member's first name.

    lastNamestring

    Member's last name.

    emailstring

    Member's email address, used as the account login and primary contact.

    displayTitlestring

    Read-only display name for the member, composed from first and last name.

    avatarImageUrlstring

    URL of the member's small avatar image; absent when no avatar is set.

    profileImageUrlstring

    URL of the member's full-size profile image; absent when none is set.

    primaryPhone object

    The member's primary phone number as an object (number, type, and primary flag); absent when no phone is on file.

    primaryboolean

    Whether this is the primary phone number.

    typestring

    Number type. Default main.

    numberstring

    The phone number.

    activeboolean

    Whether the member's Gigwell account is active.

  • ]
  • requestIdstringnullable

    A request correlation id generated by the server.

    ListRosterMembersResponse
    {
    "status": "OK",
    "code": "string",
    "message": "string",
    "messages": [
    "string"
    ],
    "data": {
    "identityId": "string",
    "title": "string",
    "webtitle": "string",
    "avatarImageUrl": "string",
    "profileImageUrl": "string",
    "bannerImageUrl": "string",
    "roster": {
    "id": "string",
    "entries": [
    {
    "sortOrder": 0,
    "entityId": "string",
    "agents": [
    {
    "accountId": "string",
    "autoAdd": true
    }
    ],
    "assistants": [
    {
    "accountId": "string",
    "autoAdd": true
    }
    ],
    "logisticians": [
    {
    "accountId": "string",
    "autoAdd": true
    }
    ],
    "marketing": [
    {
    "accountId": "string",
    "autoAdd": true
    }
    ],
    "tags": [
    "string"
    ],
    "activeOnRoster": true,
    "marketplace": true,
    "booknow": true,
    "restricted": true,
    "riderId": "string",
    "createdDate": "string",
    "updatedDate": "string"
    }
    ],
    "entryCount": 0,
    "autoAlphaSort": true,
    "agentsCanUseShowBooking": true,
    "agentsCanEditRestrictedBooking": true,
    "agentsHaveFullAccess": true,
    "newArtistsBooknow": true,
    "restrictedMailboxAccess": true,
    "showInactiveArtists": true,
    "entityIdsSharingArtists": [
    "string"
    ],
    "createdDate": "string",
    "updatedDate": "string"
    },
    "artists": [
    {
    "entityId": "string",
    "title": "string",
    "webtitle": "string",
    "email": "string",
    "legalTitle": "string",
    "phoneNumber": "string",
    "avatarImageUrl": "string",
    "profileImageUrl": "string",
    "booknow": true,
    "tags": [
    "string"
    ],
    "activeOnRoster": true,
    "restricted": true
    }
    ],
    "profiles": [
    {
    "entityId": "string",
    "title": "string",
    "webtitle": "string",
    "biography": "string",
    "genres": [
    "string"
    ],
    "labels": [
    "string"
    ],
    "hashtag": "string",
    "socialNetworks": [
    {
    "name": "amazonMusic",
    "username": "string",
    "userid": "string",
    "url": "string",
    "count": 0,
    "displayed": true,
    "order": 0
    }
    ],
    "profileImages": [
    "string"
    ],
    "avatarImageUrl": "string",
    "profileImageUrl": "string",
    "profileHeaderImageUrl": "string",
    "bannerImageUrl": "string",
    "discographyUrl": "string",
    "presskitlink": "string",
    "techriderlink": "string",
    "presskitimage": "string",
    "quotes": [
    "string"
    ],
    "affiliations": "string",
    "nationality": "string",
    "city": "string",
    "country": "string",
    "countryName": "string",
    "hometown": "string",
    "customFields": [
    {
    "values": [
    "string"
    ],
    "entityId": "string",
    "presetType": "accountFilter"
    }
    ],
    "activeOnRoster": true,
    "restricted": true,
    "soundcloudmedia": [
    {
    "fullWidth": true,
    "name": "string",
    "stream_url": "string",
    "url": "string",
    "validation": {
    "error": "INVALID_URL",
    "status": "VALID",
    "dateTime": "string",
    "providerName": "string",
    "type": "photo"
    }
    }
    ],
    "mixcloudmedia": [
    {
    "fullWidth": true,
    "name": "string",
    "stream_url": "string",
    "url": "string",
    "validation": {
    "error": "INVALID_URL",
    "status": "VALID",
    "dateTime": "string",
    "providerName": "string",
    "type": "photo"
    }
    }
    ],
    "youtubemedia": [
    {
    "fullWidth": true,
    "name": "string",
    "stream_url": "string",
    "url": "string",
    "validation": {
    "error": "INVALID_URL",
    "status": "VALID",
    "dateTime": "string",
    "providerName": "string",
    "type": "photo"
    }
    }
    ],
    "reach": 0,
    "customReach": 0,
    "capacity": 0,
    "thedjlistrank": 0,
    "owner": "string",
    "displayTitle": "string",
    "multimedia": [
    {
    "fullWidth": true,
    "name": "string",
    "stream_url": "string",
    "url": "string",
    "validation": {
    "error": "INVALID_URL",
    "status": "VALID",
    "dateTime": "string",
    "providerName": "string",
    "type": "photo"
    }
    }
    ],
    "updatedDate": "string",
    "createdDate": "string"
    }
    ],
    "artistMemberAccounts": {},
    "invitedArtistMemberAccountRoles": {},
    "agents": [
    {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "displayTitle": "string",
    "avatarImageUrl": "string",
    "profileImageUrl": "string",
    "primaryPhone": {
    "primary": true,
    "type": "string",
    "number": "string"
    },
    "active": true
    }
    ]
    },
    "requestId": "string"
    }