Loading...
Skip to main content

Get an Agent.​

Get an Agent.

Path Parameters
    agentId string required

    The ID of the Agent to retrieve.

Responses

OK

Schema
    agent object

    Represents a Fixie Agent.

    agentId string

    The unique ID of this Agent.

    owner object

    The owner of this Agent.

    user object

    Represents a single Fixie User.

    userId string

    The unique user ID for this user.

    This field should not be populated in client requests.

    email string

    The email address for this user.

    fullName string

    The name of the user. This is only used for display purposes.

    avatarUrl string

    The URL of the avatar image for this user.

    created date-time

    When this user was created.

    This field should not be populated in client requests.

    modified date-time

    When this user was last modified.

    This field should not be populated in client requests.

    apiToken string

    The user's API token. This is only populated when a user accesses their own account information.

    lastLogin date-time

    When this user last logged in.

    This field should not be populated in client requests.

    subscriptions object[]

    The subscriptions for this user.

  • Array [
    • id string

    The unique ID for this subscription.

    type enum

    Possible values: [SUBSCRIPTION_TYPE_UNSPECIFIED, SUBSCRIPTION_TYPE_BUILDER, SUBSCRIPTION_TYPE_STARTER, SUBSCRIPTION_TYPE_PERFORMANCE, SUBSCRIPTION_TYPE_OTHER]

    The type of subscription this represents.

    state enum

    Possible values: [SUBSCRIPTION_STATE_UNSPECIFIED, SUBSCRIPTION_STATE_ACTIVE, SUBSCRIPTION_STATE_CANCELED, SUBSCRIPTION_STATE_EXPIRED, SUBSCRIPTION_STATE_CANCEL_PENDING]

    The state of this subscription.

    description string

    A description of this subscription.

    created date-time

    When this subscription was created. This may not represent when the subscription was active, due to backdating.

    modified date-time

    When this subscription was last modified.

    startTime date-time

    The timestamp when this subscription starts.

    endTime date-time

    The timestamp when this subscription ends. If this subscription is active and has not been canceled, it will renew at this time.

  • ]
    • team object

    Represents a Fixie Team.

    teamId string

    The unique ID for this team.

    This field should not be populated in client requests.

    displayName string

    The display name for this team.

    description string

    The description for this team.

    avatarUrl string

    The URL of the avatar image for this team.

    members object[]

    The members of this Team.

  • Array [
    • teamId string

    The team ID.

    user object

    The user that is a member of this Team.

    userId string

    The unique user ID for this user.

    This field should not be populated in client requests.

    email string

    The email address for this user.

    fullName string

    The name of the user. This is only used for display purposes.

    avatarUrl string

    The URL of the avatar image for this user.

    created date-time

    When this user was created.

    This field should not be populated in client requests.

    modified date-time

    When this user was last modified.

    This field should not be populated in client requests.

    apiToken string

    The user's API token. This is only populated when a user accesses their own account information.

    lastLogin date-time

    When this user last logged in.

    This field should not be populated in client requests.

    subscriptions object[]

    The subscriptions for this user.

  • Array [
    • id string

    The unique ID for this subscription.

    type enum

    Possible values: [SUBSCRIPTION_TYPE_UNSPECIFIED, SUBSCRIPTION_TYPE_BUILDER, SUBSCRIPTION_TYPE_STARTER, SUBSCRIPTION_TYPE_PERFORMANCE, SUBSCRIPTION_TYPE_OTHER]

    The type of subscription this represents.

    state enum

    Possible values: [SUBSCRIPTION_STATE_UNSPECIFIED, SUBSCRIPTION_STATE_ACTIVE, SUBSCRIPTION_STATE_CANCELED, SUBSCRIPTION_STATE_EXPIRED, SUBSCRIPTION_STATE_CANCEL_PENDING]

    The state of this subscription.

    description string

    A description of this subscription.

    created date-time

    When this subscription was created. This may not represent when the subscription was active, due to backdating.

    modified date-time

    When this subscription was last modified.

    startTime date-time

    The timestamp when this subscription starts.

    endTime date-time

    The timestamp when this subscription ends. If this subscription is active and has not been canceled, it will renew at this time.

  • ]
    • role object

    The user's role on the Team.

    isAdmin boolean

    True if the user is an admin for the team.

    pending boolean

    Whether the membership is pending acceptance of an invitation by the user.

    created date-time

    When this membership was created.

    modified date-time

    When this membership was last modified.

  • ]
    • created date-time

    When this team was created.

    This field should not be populated in client requests.

    modified date-time

    When this team was last modified.

    This field should not be populated in client requests.

    subscriptions object[]

    The subscriptions for this team.

  • Array [
    • id string

    The unique ID for this subscription.

    type enum

    Possible values: [SUBSCRIPTION_TYPE_UNSPECIFIED, SUBSCRIPTION_TYPE_BUILDER, SUBSCRIPTION_TYPE_STARTER, SUBSCRIPTION_TYPE_PERFORMANCE, SUBSCRIPTION_TYPE_OTHER]

    The type of subscription this represents.

    state enum

    Possible values: [SUBSCRIPTION_STATE_UNSPECIFIED, SUBSCRIPTION_STATE_ACTIVE, SUBSCRIPTION_STATE_CANCELED, SUBSCRIPTION_STATE_EXPIRED, SUBSCRIPTION_STATE_CANCEL_PENDING]

    The state of this subscription.

    description string

    A description of this subscription.

    created date-time

    When this subscription was created. This may not represent when the subscription was active, due to backdating.

    modified date-time

    When this subscription was last modified.

    startTime date-time

    The timestamp when this subscription starts.

    endTime date-time

    The timestamp when this subscription ends. If this subscription is active and has not been canceled, it will renew at this time.

  • ]
    • handle string required

    A short handle for this Agent.

    displayName string

    The display name of this Agent.

    description string

    A description of this Agent.

    moreInfoUrl string

    A URL with more information about this Agent.

    created date-time

    The creation time of this Agent.

    modified date-time

    The last time this Agent was modified.

    currentRevisionId string

    The current Agent Revision ID used by this Agent.

    published boolean

    Whether this Agent is published. Published Agents may be accessed by unauthenticated users.

    branded boolean

    Whether this Agent's UI is branded with the "Powered by Fixie" logo.

Loading...