List opportunities in a list

client.List.ListOpportunities(ctx, listID, query) (*ListListOpportunitiesResponse, error)

GET/v1/lists/{listId}/opportunities

Returns a paginated list of opportunities that belong to the specified list.

Required scopes: lists:read and opportunities:read

Rate limit category: Search

ParametersExpand Collapse

listID string

Unique identifier of the list.

query ListListOpportunitiesParams

Limit param.Field[int64]Optional

Maximum number of records to return. Defaults to 25, maximum 25.

minimum1

maximum25

Offset param.Field[int64]Optional

Number of records to skip for pagination. Defaults to 0.

minimum0

maximum9007199254740991

ReturnsExpand Collapse

type ListListOpportunitiesResponse struct{…}

Data []ListListOpportunitiesResponseData

Array of entity objects for the current page.

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, ListListOpportunitiesResponseDataField]

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

Value ListListOpportunitiesResponseDataFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ListListOpportunitiesResponseDataFieldValueArray []string

type ListListOpportunitiesResponseDataFieldValueAddress 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 ListListOpportunitiesResponseDataFieldValueFullName 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 ListListOpportunitiesResponseDataFieldValueTypeAddress ListListOpportunitiesResponseDataFieldValueType = "ADDRESS"

const ListListOpportunitiesResponseDataFieldValueTypeCheckbox ListListOpportunitiesResponseDataFieldValueType = "CHECKBOX"

const ListListOpportunitiesResponseDataFieldValueTypeCurrency ListListOpportunitiesResponseDataFieldValueType = "CURRENCY"

const ListListOpportunitiesResponseDataFieldValueTypeDatetime ListListOpportunitiesResponseDataFieldValueType = "DATETIME"

const ListListOpportunitiesResponseDataFieldValueTypeEmail ListListOpportunitiesResponseDataFieldValueType = "EMAIL"

const ListListOpportunitiesResponseDataFieldValueTypeFullName ListListOpportunitiesResponseDataFieldValueType = "FULL_NAME"

const ListListOpportunitiesResponseDataFieldValueTypeMarkdown ListListOpportunitiesResponseDataFieldValueType = "MARKDOWN"

const ListListOpportunitiesResponseDataFieldValueTypeMultiSelect ListListOpportunitiesResponseDataFieldValueType = "MULTI_SELECT"

const ListListOpportunitiesResponseDataFieldValueTypeNumber ListListOpportunitiesResponseDataFieldValueType = "NUMBER"

const ListListOpportunitiesResponseDataFieldValueTypeSingleSelect ListListOpportunitiesResponseDataFieldValueType = "SINGLE_SELECT"

const ListListOpportunitiesResponseDataFieldValueTypeSocialHandle ListListOpportunitiesResponseDataFieldValueType = "SOCIAL_HANDLE"

const ListListOpportunitiesResponseDataFieldValueTypeTelephone ListListOpportunitiesResponseDataFieldValueType = "TELEPHONE"

const ListListOpportunitiesResponseDataFieldValueTypeText ListListOpportunitiesResponseDataFieldValueType = "TEXT"

const ListListOpportunitiesResponseDataFieldValueTypeURL ListListOpportunitiesResponseDataFieldValueType = "URL"

HTTPLink string

URL to view the entity in the Lightfield web app, or null.

Relationships map[string, ListListOpportunitiesResponseDataRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).

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.

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.

Object string

The object type, always "list".

TotalCount int64

Total number of entities matching the query.

minimum0

maximum9007199254740991

List opportunities in a list

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"),
  )
  listListOpportunitiesResponse, err := client.List.ListOpportunities(
    context.TODO(),
    "listId",
    githubcomlightfldlightfieldgo.ListListOpportunitiesParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", listListOpportunitiesResponse.Data)
}

{
  "data": [
    {
      "id": "id",
      "createdAt": "createdAt",
      "fields": {
        "foo": {
          "value": "string",
          "valueType": "ADDRESS"
        }
      },
      "httpLink": "httpLink",
      "relationships": {
        "foo": {
          "cardinality": "cardinality",
          "objectType": "objectType",
          "values": [
            "string"
          ]
        }
      },
      "updatedAt": "updatedAt",
      "externalId": "externalId"
    }
  ],
  "object": "object",
  "totalCount": 0
}

Returns Examples

{
  "data": [
    {
      "id": "id",
      "createdAt": "createdAt",
      "fields": {
        "foo": {
          "value": "string",
          "valueType": "ADDRESS"
        }
      },
      "httpLink": "httpLink",
      "relationships": {
        "foo": {
          "cardinality": "cardinality",
          "objectType": "objectType",
          "values": [
            "string"
          ]
        }
      },
      "updatedAt": "updatedAt",
      "externalId": "externalId"
    }
  ],
  "object": "object",
  "totalCount": 0
}