0

Retrieve a Civic Address

by
Published Apr 8, 2025

Return the details of an existing Civic Address with its Locations inside the 'data' attribute of the response.

Script telnyx Verified

The script

Submitted by hugo697 Bun
Verified 428 days ago
1
//native
2
type Telnyx = {
3
	apiKey: string
4
}
5
/**
6
 * Retrieve a Civic Address
7
 * Return the details of an existing Civic Address with its Locations inside the 'data' attribute of the response.
8
 */
9
export async function main(auth: Telnyx, id: string, address_id: string) {
10
	const url = new URL(
11
		`https://api.telnyx.com/v2/external_connections/${id}/civic_addresses/${address_id}`
12
	)
13

14
	const response = await fetch(url, {
15
		method: 'GET',
16
		headers: {
17
			Authorization: 'Bearer ' + auth.apiKey
18
		},
19
		body: undefined
20
	})
21
	if (!response.ok) {
22
		const text = await response.text()
23
		throw new Error(`${response.status} ${text}`)
24
	}
25
	return await response.json()
26
}
27