Skip to content

Retrieve an opportunity

client.Opportunity.Get(ctx, id) (*OpportunityRetrieveResponseUnion, error)
GET/v1/opportunities/{id}

Retrieves a single opportunity by its ID. A record you may see by name only is returned as { id, restricted: { name, reason } }, with no fields or relationships; check for restricted before reading them.

Required scope: opportunities:read

Rate limit category: Read

ParametersExpand Collapse
id string

Unique identifier of the opportunity to retrieve.

ReturnsExpand Collapse
type OpportunityRetrieveResponseUnion interface{…}
One of the following:
type OpportunityRetrieveResponseEntity struct{…}
ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, OpportunityRetrieveResponseEntityField]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

Value OpportunityRetrieveResponseEntityFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type OpportunityRetrieveResponseEntityFieldValueArray []string
type OpportunityRetrieveResponseEntityFieldValueAddress struct{…}
City stringOptional

City name.

Country stringOptional

2-letter ISO 3166-1 alpha-2 country code.

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type OpportunityRetrieveResponseEntityFieldValueFullName struct{…}
FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:
const OpportunityRetrieveResponseEntityFieldValueTypeAddress OpportunityRetrieveResponseEntityFieldValueType = "ADDRESS"
const OpportunityRetrieveResponseEntityFieldValueTypeCheckbox OpportunityRetrieveResponseEntityFieldValueType = "CHECKBOX"
const OpportunityRetrieveResponseEntityFieldValueTypeCurrency OpportunityRetrieveResponseEntityFieldValueType = "CURRENCY"
const OpportunityRetrieveResponseEntityFieldValueTypeDate OpportunityRetrieveResponseEntityFieldValueType = "DATE"
const OpportunityRetrieveResponseEntityFieldValueTypeDatetime OpportunityRetrieveResponseEntityFieldValueType = "DATETIME"
const OpportunityRetrieveResponseEntityFieldValueTypeEmail OpportunityRetrieveResponseEntityFieldValueType = "EMAIL"
const OpportunityRetrieveResponseEntityFieldValueTypeFullName OpportunityRetrieveResponseEntityFieldValueType = "FULL_NAME"
const OpportunityRetrieveResponseEntityFieldValueTypeMarkdown OpportunityRetrieveResponseEntityFieldValueType = "MARKDOWN"
const OpportunityRetrieveResponseEntityFieldValueTypeMultiSelect OpportunityRetrieveResponseEntityFieldValueType = "MULTI_SELECT"
const OpportunityRetrieveResponseEntityFieldValueTypeNumber OpportunityRetrieveResponseEntityFieldValueType = "NUMBER"
const OpportunityRetrieveResponseEntityFieldValueTypeSingleSelect OpportunityRetrieveResponseEntityFieldValueType = "SINGLE_SELECT"
const OpportunityRetrieveResponseEntityFieldValueTypeSocialHandle OpportunityRetrieveResponseEntityFieldValueType = "SOCIAL_HANDLE"
const OpportunityRetrieveResponseEntityFieldValueTypeTelephone OpportunityRetrieveResponseEntityFieldValueType = "TELEPHONE"
const OpportunityRetrieveResponseEntityFieldValueTypeText OpportunityRetrieveResponseEntityFieldValueType = "TEXT"
const OpportunityRetrieveResponseEntityFieldValueTypeURL OpportunityRetrieveResponseEntityFieldValueType = "URL"
const OpportunityRetrieveResponseEntityFieldValueTypeHTML OpportunityRetrieveResponseEntityFieldValueType = "HTML"
Relationships map[string, OpportunityRetrieveResponseEntityRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.

Cardinality string

Whether the relationship is has_one or has_many.

ObjectType string

The type of the related object (e.g. account, contact).

Values []string

IDs of the related entities.

Directions OpportunityRetrieveResponseEntityRelationshipDirectionsOptional

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

AsDestination OpportunityRetrieveResponseEntityRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const OpportunityRetrieveResponseEntityRelationshipDirectionsAsDestinationCardinalityHasOne OpportunityRetrieveResponseEntityRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const OpportunityRetrieveResponseEntityRelationshipDirectionsAsDestinationCardinalityHasMany OpportunityRetrieveResponseEntityRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource OpportunityRetrieveResponseEntityRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const OpportunityRetrieveResponseEntityRelationshipDirectionsAsSourceCardinalityHasOne OpportunityRetrieveResponseEntityRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const OpportunityRetrieveResponseEntityRelationshipDirectionsAsSourceCardinalityHasMany OpportunityRetrieveResponseEntityRelationshipDirectionsAsSourceCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

UpdatedAt string

ISO 8601 timestamp of when the entity was last updated, or null.

ExternalID stringOptional

External identifier for the entity, or null if unset.

type OpportunityRetrieveResponseRestricted struct{…}
ID string

Unique identifier for the record, the same ID a full response carries.

Restricted OpportunityRetrieveResponseRestrictedRestricted

Present only on a record the caller may know exists but not read. Check for it before reading fields or relationships, which a restricted record does not carry.

Name string

A label for the record’s type, such as “Restricted opportunity”. Never the record’s name.

Reason string

Why the record is restricted.

One of the following:
const OpportunityRetrieveResponseRestrictedRestrictedReasonNoAccess OpportunityRetrieveResponseRestrictedRestrictedReason = "NO_ACCESS"
const OpportunityRetrieveResponseRestrictedRestrictedReasonInherited OpportunityRetrieveResponseRestrictedRestrictedReason = "INHERITED"

Retrieve an opportunity

package main

import (
  "context"
  "fmt"

  "github.com/Lightfld/lightfield-go"
  "github.com/Lightfld/lightfield-go/option"
)

func main() {
  client := githubcomlightfldlightfieldgo.NewClient(
    option.WithAPIKey("My API Key"),
  )
  opportunityRetrieveResponse, err := client.Opportunity.Get(context.TODO(), "id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", opportunityRetrieveResponse)
}
{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "values": [
        "string"
      ],
      "directions": {
        "asDestination": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        },
        "asSource": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        }
      }
    }
  },
  "updatedAt": "updatedAt",
  "externalId": "externalId"
}
Returns Examples
{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "values": [
        "string"
      ],
      "directions": {
        "asDestination": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        },
        "asSource": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        }
      }
    }
  },
  "updatedAt": "updatedAt",
  "externalId": "externalId"
}